{
  "openapi": "3.1.0",
  "info": {
    "description": "Claim House API: the operations that are live today. Everything else in the docs is Coming soon. Guides and errors: https://docs.claimhouse.ai",
    "title": "Claim House API",
    "version": "docs-20261005-1 (c92ac19)",
    "contact": {
      "name": "Claim House support",
      "email": "support@claimhouse.ai",
      "url": "https://docs.claimhouse.ai"
    }
  },
  "servers": [
    {
      "url": "https://api.claimhouse.ai",
      "description": "Test and live: the key decides the mode."
    }
  ],
  "paths": {
    "/v1/access-requests": {
      "get": {
        "operationId": "listAccessRequests",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {},
                "example": {
                  "request_id": "evt_smqb8kmqf7gk589mq1ys",
                  "access_requests": [
                    {
                      "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                      "request_id": "arq_EXAMPLE0000000000001",
                      "requester_issuer": "https://issuer.EXAMPLE",
                      "requester_user_id": "user_EXAMPLE0000000000001",
                      "organization_reference": "SAMPLE-DENTAL-GROUP",
                      "relationship_reason": "I manage billing for two Sample Dental Group offices.",
                      "status": "PENDING",
                      "reviewer_id": null,
                      "review_reason": null,
                      "version": 1,
                      "idempotency_key": "3f0c2a4e-EXAMPLE-idempotency-key",
                      "created_at": "2026-09-14T15:04:05+00:00",
                      "reviewed_at": null
                    }
                  ]
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List access requests",
        "tags": [
          "members"
        ],
        "description": "List every access request made to your organization, newest first."
      }
    },
    "/v1/api-requests": {
      "get": {
        "description": "Every call to the Claim House API for your organization, from API keys and the\ndashboard, newest first: route, status, time taken, office, ids touched, error code.\n\nNo request or response bodies and no patient details are kept; open a listed id\n(for example a check) to see it. A caller limited to some offices sees only calls\nfor those offices.",
        "operationId": "listApiRequests",
        "parameters": [
          {
            "in": "query",
            "name": "facility_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Facility Id"
            },
            "example": "fac_tycrfy0cs0qc7sq95eme"
          },
          {
            "in": "query",
            "name": "outcome",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(ok|error|client_error|server_error)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Outcome"
            },
            "example": "error"
          },
          {
            "in": "query",
            "name": "source",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(api_key|dashboard)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Source"
            },
            "example": "api_key"
          },
          {
            "in": "query",
            "name": "product",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 40,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Product"
            },
            "example": "eligibility"
          },
          {
            "in": "query",
            "name": "key_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Key Id"
            },
            "example": "key_7qm2x9d4hs3ve6kt8wbn"
          },
          {
            "in": "query",
            "name": "resource_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Resource Id"
            },
            "example": "elg_skvgqer72n4zf02jz5rb"
          },
          {
            "in": "query",
            "name": "changes_only",
            "required": false,
            "schema": {
              "default": false,
              "title": "Changes Only",
              "type": "boolean"
            },
            "example": true
          },
          {
            "in": "query",
            "name": "before",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 120,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Before"
            },
            "example": "2026-09-28T16:39:48.842388+00:00|evt_f911mnkad52wv96ggzty"
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 100,
              "maximum": 500,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            },
            "example": 2
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "request_id": "evt_c171bg4fc97bz4xawf4n",
                  "data": [
                    {
                      "request_id": "evt_zejc8pc58d7xfd2fntvw",
                      "received_at": "2026-09-28T16:39:48.843382+00:00",
                      "method": "GET",
                      "route": "/v1/eligibility",
                      "status": 403,
                      "latency_ms": 3,
                      "source": "api_key",
                      "key_id": "key_c8m2x9d4hs3ve6kt8wbn",
                      "actor_id": null,
                      "mode": "production",
                      "facility_id": "fac_w9qxypnbcw7b308jbbhh",
                      "product": "eligibility",
                      "resource_ids": [],
                      "error_code": "FACILITY_NOT_GRANTED"
                    },
                    {
                      "request_id": "evt_m1vn1w69c52c7e5wjhf2",
                      "received_at": "2026-09-28T16:39:47.836017+00:00",
                      "method": "POST",
                      "route": "/v1/eligibility",
                      "status": 200,
                      "latency_ms": 1840,
                      "source": "api_key",
                      "key_id": "key_7qm2x9d4hs3ve6kt8wbn",
                      "actor_id": null,
                      "mode": "production",
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "product": "eligibility",
                      "resource_ids": [
                        "elg_skvgqer72n4zf02jz5rb"
                      ],
                      "error_code": null
                    }
                  ],
                  "next_cursor": "2026-09-28T16:39:47.836017+00:00|evt_m1vn1w69c52c7e5wjhf2"
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List API requests",
        "tags": [
          "activity"
        ]
      }
    },
    "/v1/artifacts/{artifact_id}": {
      "get": {
        "description": "A short-lived URL to the seller's own copy of one archived file.",
        "operationId": "getArtifact",
        "parameters": [
          {
            "in": "path",
            "name": "artifact_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Artifact Id",
              "type": "string"
            },
            "example": "art_5ajgzw1wwge9x43v86b2"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "request_id": "evt_1jnvj4ackt0ndkm9awpm",
                  "artifact_id": "art_5ajgzw1wwge9x43v86b2",
                  "download_filename": null,
                  "claim_id": "clm_sey00k954s2ctghndb3h",
                  "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                  "event_kind": "claim.transported",
                  "url": "https://archive.example/sellers/sel_s4zf3w33k6x8j1e1z6sh/fac_tycrfy0cs0qc7sq95eme/artifacts/art_5ajgzw1wwge9x43v86b2?ttl=600",
                  "expires_in_seconds": 600
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Get an artifact",
        "tags": [
          "artifacts"
        ]
      }
    },
    "/v1/billing": {
      "get": {
        "description": "The organization's billing account: state, the card on file (brand,\nlast 4 and expiry only), and whether live requests are open.",
        "operationId": "getBilling",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingAccountResponse"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_2fqv1c3h5k8m9n0p7r6s",
                  "state": "ACTIVE",
                  "mode": "CARD",
                  "processor_mode": "test",
                  "card": {
                    "brand": "visa",
                    "last4": "4242",
                    "exp_month": 4,
                    "exp_year": 2028
                  },
                  "state_reason": "card_saved",
                  "state_changed_at": "2026-10-05T12:00:00+00:00",
                  "live_billing_ok": true,
                  "can_manage": true,
                  "card_setup_available": true
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Get billing",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/billing/card-session": {
      "post": {
        "description": "Open hosted card setup. Returns the URL to send the person to; the\ncard is saved only when the signed card processor event arrives.",
        "operationId": "createCardSession",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardSessionBody"
              },
              "example": {
                "nonce": "3f2b6c1e-8d4a-4b5e-9c1a-2e7f6d5c4b3a"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingRedirectResponse"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_8sgg4m61en3dsc4ewj0d",
                  "url": "https://pay.example.com/card/cs_test_EXAMPLE"
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Open card setup",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/billing/portal-session": {
      "post": {
        "description": "Open the hosted page that replaces or removes the card on file.",
        "operationId": "createPortalSession",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingRedirectResponse"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_t9nsqb25r11sf2j4q3j7",
                  "url": "https://pay.example.com/manage/EXAMPLE"
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Open the card portal",
        "tags": [
          "billing"
        ]
      }
    },
    "/v1/eligibility": {
      "get": {
        "description": "Every check across the caller's offices, newest first, with the people on each request.\n\nFilters: one or more ``facility_id``, ``status`` (``ERROR`` means the payer\ndid not answer), ``q`` (words matched against names, member id, payer id,\nthe payer's name and your reference), ``batch_id`` (the checks one batch\nmade) and ``since`` (an ISO 8601 time: checks retrieved at or after it,\nfor pulling everything new since your last pull). ``before`` is the\n``next`` cursor of the previous page. Each row names its ``batch_id``\n(null for a single check) and your ``reference``.",
        "operationId": "listEligibilityChecks",
        "parameters": [
          {
            "in": "query",
            "name": "facility_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Facility Id"
            },
            "example": "fac_tycrfy0cs0qc7sq95eme"
          },
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(ACTIVE|INACTIVE|UNKNOWN|ERROR)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Status"
            },
            "example": "ACTIVE"
          },
          {
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 120,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Q"
            },
            "example": "testpatient"
          },
          {
            "in": "query",
            "name": "before",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 120,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Before"
            },
            "example": "2026-09-07T15:00:10+00:00|elg_skvgqer72n4zf02jz5rb"
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 100,
              "maximum": 500,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            },
            "example": 2
          },
          {
            "in": "query",
            "name": "batch_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "minLength": 1,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Batch Id"
            },
            "example": "bat_EXAMPLE0000000000001"
          },
          {
            "in": "query",
            "name": "since",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Since"
            },
            "example": "2026-10-05T00:00:00Z"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilityListPage"
                },
                "example": {
                  "request_id": "evt_v2d5abcabd28samwxfsk",
                  "results": [
                    {
                      "eligibility_id": "elg_skvgqer72n4zf02jz5rb",
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "payer_id": "TESTPAYER1",
                      "relationship": "child",
                      "service_date": "2026-09-07",
                      "status": "ACTIVE",
                      "outcome": "OK",
                      "error_class": null,
                      "vendor_latency_ms": 1840,
                      "tenant_reference": "visit-0002",
                      "retrieved_at": "2026-09-07T15:00:10+00:00",
                      "rejection_summary": null,
                      "billing": {
                        "charged": true,
                        "state": "BILLABLE",
                        "reason": "answered",
                        "label": "Payer answered",
                        "reason_label": "The payer answered this check; checks the payer answers are charged",
                        "unit_price_micros": null
                      },
                      "source": {
                        "network": "claimhouse",
                        "reference": "txn-EXAMPLE-0002"
                      },
                      "mode": "production",
                      "subscriber": {
                        "first_name": "Jane",
                        "last_name": "Testpatient",
                        "date_of_birth": "1980-01-15",
                        "member_id": "SYN000123456"
                      },
                      "patient": {
                        "first_name": "Sam",
                        "last_name": "Testpatient",
                        "date_of_birth": "2015-01-01"
                      }
                    },
                    {
                      "eligibility_id": "elg_6zm731h2sd161402r84g",
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "payer_id": "TESTPAYER1",
                      "relationship": "self",
                      "service_date": "2026-09-07",
                      "status": "ACTIVE",
                      "outcome": "OK",
                      "error_class": null,
                      "vendor_latency_ms": 1320,
                      "tenant_reference": "visit-0001",
                      "retrieved_at": "2026-09-07T15:00:00+00:00",
                      "rejection_summary": null,
                      "billing": {
                        "charged": true,
                        "state": "BILLABLE",
                        "reason": "answered",
                        "label": "Payer answered",
                        "reason_label": "The payer answered this check; checks the payer answers are charged",
                        "unit_price_micros": null
                      },
                      "source": {
                        "network": "claimhouse",
                        "reference": "txn-EXAMPLE-0001"
                      },
                      "mode": "production",
                      "subscriber": {
                        "first_name": "Jane",
                        "last_name": "Testpatient",
                        "date_of_birth": "1980-01-15",
                        "member_id": "SYN000123456"
                      },
                      "patient": null
                    }
                  ],
                  "next": null
                }
              }
            },
            "description": "Checks, newest first",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List eligibility checks",
        "tags": [
          "eligibility"
        ]
      },
      "post": {
        "description": "One eligibility check: one vendor call, never a retry.\n\nThree bodies are accepted on this route: the flat request\n``EligibilityFlatRequest`` (``office``, ``insurance``, ``member_id``,\n``patient``; the Idempotency-Key is optional and derived when left\nout), the camelCase partner JSON ``EligibilityCheckRequest``\n(``tradingPartnerServiceId``, ``subscriber``, ``dependents[]``,\n``encounter``, plus ``facilityId``) and the original snake_case\n``EligibilityBody``. A body mixing the flat request with another\nshape is 422 ``REQUEST_SHAPES_MIXED``. ``mode`` selects\nstandard, enhanced, or auto detail. ``Cache-Control:\nno-cache`` forces a live check; the same ``Idempotency-Key`` with the\nsame body replays the recorded answer. Optional ``include=pdf`` also\nmakes the check's PDF and returns its ``artifact_id``.",
        "operationId": "checkEligibility",
        "parameters": [
          {
            "description": "Detail level override (same semantics as body.mode). auto picks enhanced when the payer supports it. Default standard.",
            "in": "query",
            "name": "mode",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "standard",
                    "enhanced",
                    "auto"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Detail level override (same semantics as body.mode). auto picks enhanced when the payer supports it. Default standard.",
              "title": "Mode"
            },
            "example": "auto"
          },
          {
            "description": "Comma list. include=pdf also makes this check's PDF and returns its artifact_id.",
            "in": "query",
            "name": "include",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Comma list. include=pdf also makes this check's PDF and returns its artifact_id.",
              "title": "Include"
            },
            "example": "pdf"
          },
          {
            "description": "Reuse a stored answer at most this old (same as body max_age_seconds); 0 always asks the payer.",
            "in": "query",
            "name": "max_age_seconds",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maximum": 604800,
                  "minimum": 0,
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Reuse a stored answer at most this old (same as body max_age_seconds); 0 always asks the payer.",
              "title": "Max Age Seconds"
            },
            "example": 0
          },
          {
            "description": "The identity of one intended check. Required for the camelCase and snake_case bodies (400 IDEMPOTENCY_KEY_REQUIRED without it). Optional for the flat request: without it Claim House derives one from the check's content and the UTC day, and returns it in request.idempotency_key. Retain it with the original request for replay or reconciliation.",
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "minLength": 1,
              "type": "string"
            },
            "example": "first-check-ab12cd"
          },
          {
            "in": "header",
            "name": "Cache-Control",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cache-Control"
            },
            "example": "no-cache"
          },
          {
            "description": "Test keys only: force one test outcome for any sample patient, by scenario or magic member ID (for example CH-AAA-72). An unknown value is refused with 422 TEST_SCENARIO_UNKNOWN.",
            "in": "header",
            "name": "X-Test-Scenario",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "CH-AAA-72"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            },
            "example": "2026-11-01"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/EligibilityBody"
                  },
                  {
                    "$ref": "#/components/schemas/EligibilityCheckRequest"
                  },
                  {
                    "$ref": "#/components/schemas/EligibilityFlatRequest"
                  }
                ]
              },
              "example": {
                "office": "SBX",
                "insurance": "94276",
                "member_id": "CH-ACTIVE-FULL",
                "patient": {
                  "first_name": "Riley",
                  "last_name": "Molar",
                  "date_of_birth": "2015-06-02"
                },
                "relationship": "child",
                "subscriber": {
                  "first_name": "Avery",
                  "last_name": "Molar",
                  "date_of_birth": "1970-01-10"
                },
                "procedures": [
                  "D0120",
                  "d1110"
                ],
                "visit_date": "20260907",
                "view": "summary"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EligibilityCheckResponseV3"
                    },
                    {
                      "$ref": "#/components/schemas/EligibilityCheckResponse"
                    }
                  ]
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_9j3v95tbkd77k7cz2dk5",
                  "id": "elg_9aqbap922506q92gx9ge",
                  "contract": "eligibility.v3",
                  "view": "complete",
                  "status": "active",
                  "checked_at": "2026-09-07T15:00:00+00:00",
                  "verified": true,
                  "office": {
                    "id": "fac_sandboxbatchsandbx",
                    "name": "fac_sandboxbatchsandbx"
                  },
                  "payer": {
                    "id": "94276",
                    "name": "Delta Dental",
                    "id_as_returned": "94276",
                    "name_as_returned": "Delta Dental"
                  },
                  "patient": {
                    "date_of_birth": "1980-01-01",
                    "first_name": "TEST",
                    "last_name": "PATIENT",
                    "member_id": "CH-ACTIVE-FULL",
                    "relationship": "self"
                  },
                  "as_requested": {
                    "subscriber": {
                      "first_name": "Test",
                      "last_name": "Patient",
                      "date_of_birth": "1980-01-01",
                      "member_id": "CH-ACTIVE-FULL"
                    },
                    "relationship": "self",
                    "visit_date": "2026-09-07",
                    "differences": [],
                    "not_returned": [
                      "subscriber"
                    ]
                  },
                  "plan": {
                    "group_number": "TESTGRP1",
                    "insurance_type": "ppo",
                    "name": "Delta Dental PPO",
                    "coverage": {
                      "start": "2026-01-01",
                      "status": "active",
                      "termination": "2026-12-31",
                      "lines": [
                        {
                          "kind": "active_coverage",
                          "network": "in_network",
                          "insurance_type": "group_policy",
                          "text": "In network, group policy: active coverage",
                          "ref": "active_coverage[0]"
                        }
                      ]
                    }
                  },
                  "totals": {
                    "deductibles": [
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "individual",
                        "period": "calendar",
                        "service": "dental_care",
                        "amount": "50.00",
                        "text": "Dental care (general), in network, individual, calendar year: deductible $50.00",
                        "ref": "deductible[0]"
                      },
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "individual",
                        "period": "remaining",
                        "service": "dental_care",
                        "amount": "25.00",
                        "text": "Dental care (general), in network, individual, remaining: deductible $25.00",
                        "ref": "deductible[1]"
                      },
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "family",
                        "period": "calendar",
                        "service": "dental_care",
                        "amount": "150.00",
                        "text": "Dental care (general), in network, family, calendar year: deductible $150.00",
                        "ref": "deductible[2]"
                      },
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "family",
                        "period": "remaining",
                        "service": "dental_care",
                        "amount": "150.00",
                        "text": "Dental care (general), in network, family, remaining: deductible $150.00",
                        "ref": "deductible[3]"
                      }
                    ],
                    "maximums": [
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "calendar",
                        "service": "dental_care",
                        "amount": "1500.00",
                        "text": "Dental care (general), in network, individual, calendar year: maximum $1500.00",
                        "ref": "maximums[0]"
                      },
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "remaining",
                        "service": "dental_care",
                        "amount": "1200.00",
                        "text": "Dental care (general), in network, individual, remaining: maximum $1200.00",
                        "ref": "maximums[1]"
                      },
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "lifetime",
                        "service": "orthodontics",
                        "amount": "1000.00",
                        "text": "Orthodontics, in network, individual, lifetime: maximum $1000.00",
                        "ref": "maximums[2]"
                      },
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "lifetime_remaining",
                        "service": "orthodontics",
                        "amount": "1000.00",
                        "text": "Orthodontics, in network, individual, lifetime remaining: maximum $1000.00",
                        "ref": "maximums[3]"
                      }
                    ]
                  },
                  "by_service": [
                    {
                      "service": "preventive",
                      "label": "Preventive care",
                      "lines": [
                        {
                          "kind": "coinsurance",
                          "network": "in_network",
                          "percent": 100,
                          "text": "Preventive care, in network: coinsurance 100%",
                          "ref": "coinsurance[0]"
                        }
                      ]
                    },
                    {
                      "service": "restorative",
                      "label": "Restorative (fillings)",
                      "lines": [
                        {
                          "kind": "coinsurance",
                          "network": "in_network",
                          "percent": 80,
                          "text": "Restorative (fillings), in network: coinsurance 80%",
                          "ref": "coinsurance[1]"
                        }
                      ]
                    },
                    {
                      "service": "dental_crowns",
                      "label": "Crowns",
                      "lines": [
                        {
                          "kind": "coinsurance",
                          "network": "in_network",
                          "percent": 50,
                          "text": "Crowns, in network: coinsurance 50%",
                          "ref": "coinsurance[2]"
                        }
                      ]
                    }
                  ],
                  "by_procedure": [
                    {
                      "code": "D0274",
                      "code_as_sent": "AD:D0274",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 visits in 12 month",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "month",
                              "time_period_value": "12"
                            }
                          ],
                          "text": "D0274, all networks, individual: limitation 1 visits in 12 month (frequency 1 visits per 12 months)",
                          "ref": "limitations[2]"
                        },
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 units remaining",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "units",
                              "time_period_qualifier": "remaining"
                            }
                          ],
                          "text": "D0274, all networks, individual: limitation 1 units remaining (frequency 1 units, time period remaining)",
                          "ref": "limitations[3]"
                        }
                      ]
                    },
                    {
                      "code": "D1110",
                      "code_as_sent": "AD:D1110",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "2 visits in 1 calendar",
                          "frequency": [
                            {
                              "quantity": "2",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "calendar",
                              "time_period_value": "1"
                            }
                          ],
                          "text": "D1110, all networks, individual: limitation 2 visits in 1 calendar (frequency 2 visits per calendar year)",
                          "ref": "limitations[0]"
                        },
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 units remaining",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "units",
                              "time_period_qualifier": "remaining"
                            }
                          ],
                          "text": "D1110, all networks, individual: limitation 1 units remaining (frequency 1 units, time period remaining)",
                          "ref": "limitations[1]"
                        }
                      ]
                    }
                  ],
                  "missing": [
                    "not_covered",
                    "waiting_period"
                  ],
                  "not_read": [],
                  "labels": {
                    "network": {
                      "applies_all": "All networks",
                      "in_network": "In network"
                    },
                    "level": {
                      "family": "Family",
                      "individual": "Individual"
                    },
                    "period": {
                      "calendar": "Calendar year",
                      "lifetime": "Lifetime",
                      "lifetime_remaining": "Lifetime remaining",
                      "remaining": "Remaining"
                    },
                    "service": {
                      "dental_care": "Dental care (general)",
                      "dental_crowns": "Crowns",
                      "orthodontics": "Orthodontics",
                      "preventive": "Preventive care",
                      "restorative": "Restorative (fillings)"
                    },
                    "insurance_type": {
                      "group_policy": "Group policy",
                      "ppo": "PPO"
                    }
                  },
                  "counts": {
                    "payer_rows": 16,
                    "lines": 16,
                    "procedures": 2,
                    "notes": 0,
                    "history": 0
                  },
                  "links": {
                    "complete": "/v1/eligibility/elg_9aqbap922506q92gx9ge/answer?contract=v3",
                    "summary": "/v1/eligibility/elg_9aqbap922506q92gx9ge/answer?contract=v3&view=summary",
                    "lines": "/v1/eligibility/elg_9aqbap922506q92gx9ge/answer?contract=v3&view=lines",
                    "payer_answer": "/v1/eligibility/elg_9aqbap922506q92gx9ge/answer?view=payer",
                    "pdf": "/v1/eligibility/elg_9aqbap922506q92gx9ge/pdf"
                  },
                  "billing": {
                    "charged": false,
                    "state": "NOT_BILLABLE",
                    "reason": "test_mode",
                    "label": "Test mode",
                    "reason_label": "Test mode checks never reach a payer and are never charged"
                  },
                  "request": {
                    "idempotency_key": "first-check-ab12cd",
                    "idempotency_key_source": "header",
                    "replayed": false,
                    "reused": false,
                    "corrections": [
                      {
                        "field": "patient.date_of_birth",
                        "from": "YYYYMMDD",
                        "to": "YYYY-MM-DD"
                      }
                    ],
                    "payer_resolution": {
                      "input": {
                        "insurance": "94276"
                      },
                      "matched_payer_id": "94276",
                      "matched_name": "Delta Dental",
                      "method": "EXACT",
                      "confidence": "HIGH"
                    }
                  },
                  "idempotent_replay": false
                }
              }
            },
            "description": "The check. API version 2026-11-01 (the default): the answer, contract eligibility.v3 (EligibilityCheckResponseV3). Pinned to 2026-10-01: the check summary (EligibilityCheckResponse).",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              },
              "Idempotent-Replayed": {
                "description": "true when this response replays the recorded result of an earlier request with the same Idempotency-Key. Absent otherwise.",
                "schema": {
                  "enum": [
                    "true"
                  ],
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Check eligibility",
        "tags": [
          "eligibility"
        ]
      }
    },
    "/v1/eligibility/batches": {
      "get": {
        "description": "Your recent eligibility batches in this mode, newest first, with counts and no rows.\n\nA caller limited to some offices sees only batches whose offices are all in its scope.",
        "operationId": "listEligibilityBatches",
        "parameters": [
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 20,
              "maximum": 50,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            },
            "example": 20
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilityBatchList"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_zygkctdwjd64xbzka831",
                  "batches": [
                    {
                      "batch_id": "bat_4eghyt58pn73b6ezzxy2",
                      "reference": "week-of-1005",
                      "state": "CANCELLED",
                      "created_at": "2026-09-07T15:00:00Z",
                      "completed_at": "2026-09-07T15:00:00Z",
                      "cancelled_at": "2026-09-07T15:00:00Z",
                      "retry_payer_unavailable": {
                        "hours": 4
                      },
                      "counts": {
                        "rows": 4,
                        "pending": 0,
                        "running": 0,
                        "done": 2,
                        "refused": 1,
                        "needs_payer": 0,
                        "duplicate": 0,
                        "cancelled": 1,
                        "active": 1,
                        "inactive": 1,
                        "unknown": 0,
                        "not_answered": 0
                      }
                    }
                  ]
                }
              }
            },
            "description": "Batches, newest first",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List batches",
        "tags": [
          "eligibility"
        ]
      },
      "post": {
        "description": "Check many patients at once: up to 10,000 rows as ``patients`` (each the flat\n``POST /v1/eligibility`` body), as JSON ``rows`` or as ``csv`` text (8 MB).\nA top-level ``office`` and ``visit_date`` apply to every row that leaves them out.\n\n``preview: true`` validates every row, resolves each office and payer and\nfinds duplicates. It is free, makes no payer call and stores no batch.\nIn live mode it also says how many ready rows are past today's\nremaining live limit (``counts.over_daily_limit``, ``daily_limit``).\n``preview: false`` (an ``Idempotency-Key`` is required) stores the batch\nand answers 202; every ready row then runs as a normal ``POST\n/v1/eligibility`` check with its own Idempotency-Key, and rows past\ntoday's live limit are refused with ``DAILY_LIMIT_REACHED`` before any\nwork. ``retry_payer_unavailable: {\"hours\": 1 to 24}`` opts in to checking\npayer-down rows again later, each try a new check. Read the summary\nwith ``GET /v1/eligibility/batches/{batch_id}``, the rows with ``/rows``\nand the whole result as a file with ``/results``.",
        "operationId": "createEligibilityBatch",
        "parameters": [
          {
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Idempotency-Key"
            },
            "example": "batch-EXAMPLE-0001"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EligibilityBatchBody"
              },
              "example": {
                "preview": true,
                "office": "SBX",
                "visit_date": "2026-09-07",
                "patients": [
                  {
                    "reference": "appt-1",
                    "insurance": "94276",
                    "member_id": "CH-ACTIVE-FULL",
                    "patient": {
                      "first_name": "Avery",
                      "last_name": "Molar",
                      "date_of_birth": "1970-01-10"
                    }
                  },
                  {
                    "reference": "appt-2",
                    "insurance": "94276",
                    "member_id": "CH-TERMINATED",
                    "patient": {
                      "first_name": "Riley",
                      "last_name": "Molar",
                      "date_of_birth": "2015-06-02"
                    },
                    "relationship": "child",
                    "subscriber": {
                      "first_name": "Avery",
                      "last_name": "Molar",
                      "date_of_birth": "1970-01-10"
                    },
                    "visit_date": "2026-09-08"
                  }
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilityBatchPreview"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_0kx5zfa70h7mv2dv40kz",
                  "preview": true,
                  "counts": {
                    "rows": 2,
                    "ready": 2,
                    "refused": 0,
                    "needs_payer": 0,
                    "duplicate": 0,
                    "over_daily_limit": 0
                  },
                  "daily_limit": null,
                  "ignored_columns": [],
                  "rows": [
                    {
                      "index": 0,
                      "reference": "appt-1",
                      "facility_id": "fac_sandboxbatchsandbx",
                      "state": "READY",
                      "payer": {
                        "input": "94276",
                        "payer_id": "94276",
                        "payer_name": "Delta Dental",
                        "state": "EXACT"
                      }
                    },
                    {
                      "index": 1,
                      "reference": "appt-2",
                      "facility_id": "fac_sandboxbatchsandbx",
                      "state": "READY",
                      "payer": {
                        "input": "94276",
                        "payer_id": "94276",
                        "payer_name": "Delta Dental",
                        "state": "EXACT"
                      }
                    }
                  ],
                  "payer_choices": []
                }
              }
            },
            "description": "The preview (preview: true)",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilityBatchCreated"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_4vpwbe4eyx6rvfn1nczc",
                  "batch_id": "bat_4eghyt58pn73b6ezzxy2",
                  "state": "RUNNING",
                  "idempotent_replay": true,
                  "counts": {
                    "rows": 4,
                    "pending": 3,
                    "running": 0,
                    "done": 0,
                    "refused": 1,
                    "needs_payer": 0,
                    "duplicate": 0,
                    "cancelled": 0,
                    "active": 0,
                    "inactive": 0,
                    "unknown": 0,
                    "not_answered": 0
                  }
                }
              }
            },
            "description": "The batch is running",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              },
              "Idempotent-Replayed": {
                "description": "true when this response replays the recorded result of an earlier request with the same Idempotency-Key. Absent otherwise.",
                "schema": {
                  "enum": [
                    "true"
                  ],
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Check many patients",
        "tags": [
          "eligibility"
        ]
      }
    },
    "/v1/eligibility/batches/{batch_id}": {
      "get": {
        "description": "One batch: its state and counts. No rows: page through them with\n``GET /v1/eligibility/batches/{batch_id}/rows``, or download them all\nwith ``/results``.\n\n``state`` is ``RUNNING`` while any row is ``PENDING`` or ``RUNNING``;\nthen ``CANCELLED`` for a cancelled batch, else ``COMPLETE``. No patient\nvalues are returned here.",
        "operationId": "getEligibilityBatch",
        "parameters": [
          {
            "in": "path",
            "name": "batch_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Batch Id",
              "type": "string"
            },
            "example": "bat_qtncqy7e316j97d2ft0x"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilityBatchView"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_a36q7vq5y57jd79z3241",
                  "batch_id": "bat_4eghyt58pn73b6ezzxy2",
                  "reference": "week-of-1005",
                  "state": "RUNNING",
                  "created_at": "2026-09-07T15:00:00Z",
                  "completed_at": null,
                  "cancelled_at": null,
                  "retry_payer_unavailable": {
                    "hours": 4
                  },
                  "counts": {
                    "rows": 4,
                    "pending": 1,
                    "running": 0,
                    "done": 2,
                    "refused": 1,
                    "needs_payer": 0,
                    "duplicate": 0,
                    "cancelled": 0,
                    "active": 1,
                    "inactive": 1,
                    "unknown": 0,
                    "not_answered": 0
                  },
                  "mode": "test"
                }
              }
            },
            "description": "The batch summary",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Read a batch",
        "tags": [
          "eligibility"
        ]
      }
    },
    "/v1/eligibility/batches/{batch_id}/cancel": {
      "post": {
        "description": "Cancel the rest of a batch: every ``PENDING`` row becomes ``CANCELLED`` and is never sent.\n\nRows already ``RUNNING`` finish normally; a payer call in progress is\nnever interrupted. The batch reads ``CANCELLED`` once no row is\nrunning. Calling cancel again, or on a finished batch, changes nothing\nand returns the summary. ``Idempotency-Key`` is accepted and optional.",
        "operationId": "cancelEligibilityBatch",
        "parameters": [
          {
            "in": "path",
            "name": "batch_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Batch Id",
              "type": "string"
            },
            "example": "bat_EXAMPLE0000000000001"
          },
          {
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Idempotency-Key"
            },
            "example": "check-EXAMPLE-0001"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilityBatchCancelled"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_erh276p0ks2xh5f8w57n",
                  "batch_id": "bat_4ewhr3yg3d2m55mas86d",
                  "reference": null,
                  "state": "CANCELLED",
                  "created_at": "2026-09-07T15:00:00Z",
                  "completed_at": "2026-09-07T15:00:00Z",
                  "cancelled_at": "2026-09-07T15:00:00Z",
                  "retry_payer_unavailable": null,
                  "counts": {
                    "rows": 4,
                    "pending": 0,
                    "running": 0,
                    "done": 0,
                    "refused": 1,
                    "needs_payer": 0,
                    "duplicate": 0,
                    "cancelled": 3,
                    "active": 0,
                    "inactive": 0,
                    "unknown": 0,
                    "not_answered": 0
                  },
                  "mode": "test",
                  "cancelled_rows": 3
                }
              }
            },
            "description": "The batch summary after the cancel",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Cancel a batch",
        "tags": [
          "eligibility"
        ]
      }
    },
    "/v1/eligibility/batches/{batch_id}/results": {
      "get": {
        "description": "Every row of a batch as one file, streamed: ``format=csv`` (the default) or ``jsonl``.\n\nColumns, in order: ``index``, ``reference``, ``office_code``,\n``facility_id``, ``state``, ``result``, ``eligibility_id``,\n``http_status``, ``error``, ``message``, ``rejection_code``,\n``rejection_field``, ``charged``, ``billing_reason``. No dedicated patient fields;\nreferences and messages can contain customer information. CSV protects formula-like text;\nJSON lines preserve the original values.\nReady at any time: while the batch runs, rows not yet checked show their\ncurrent state. The last JSON line is ``{\"summary\": {...}}`` with the\nstate, the counts and ``rows_in_file``, which equals ``counts.rows``.\nIts ``export`` metadata names the capture interval and whether all rows\nwere already terminal when export began. If false, fetch a final export later.",
        "operationId": "getEligibilityBatchResults",
        "parameters": [
          {
            "in": "path",
            "name": "batch_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Batch Id",
              "type": "string"
            },
            "example": "bat_EXAMPLE0000000000001"
          },
          {
            "in": "query",
            "name": "format",
            "required": false,
            "schema": {
              "default": "csv",
              "pattern": "^(csv|jsonl)$",
              "title": "Format",
              "type": "string"
            }
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/x-ndjson": {
                "schema": {
                  "type": "string"
                }
              },
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "One line per row. Exports started while running are live page observations, not a final snapshot, even if the batch finishes during download.",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              },
              "X-Export-Complete": {
                "schema": {
                  "enum": [
                    "true",
                    "false"
                  ],
                  "type": "string"
                }
              },
              "X-Export-Consistency": {
                "schema": {
                  "enum": [
                    "terminal",
                    "live_pages"
                  ],
                  "type": "string"
                }
              },
              "X-Export-Started-At": {
                "schema": {
                  "format": "date-time",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Download a batch's results",
        "tags": [
          "eligibility"
        ]
      }
    },
    "/v1/eligibility/batches/{batch_id}/rows": {
      "get": {
        "description": "A batch's rows in row order, ``limit`` at a time (1 to 1,000; 500 by default).\n\nFilters: ``state`` (``PENDING``, ``RUNNING``, ``DONE``, ``REFUSED``,\n``NEEDS_PAYER``, ``DUPLICATE`` or ``CANCELLED``) and ``result``\n(``ACTIVE``, ``INACTIVE``, ``UNKNOWN``, ``NOT_ANSWERED`` or ``REFUSED``,\nwhich is a row not sent). Pass ``next_cursor`` back as ``cursor`` for\nthe next page, with the same filters; it is null at the end. A row\ncarries ids, codes, statuses and your reference, never patient values.",
        "operationId": "listEligibilityBatchRows",
        "parameters": [
          {
            "in": "path",
            "name": "batch_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Batch Id",
              "type": "string"
            },
            "example": "bat_EXAMPLE0000000000001"
          },
          {
            "in": "query",
            "name": "state",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(PENDING|RUNNING|DONE|REFUSED|NEEDS_PAYER|DUPLICATE|CANCELLED)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "State"
            }
          },
          {
            "in": "query",
            "name": "result",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(ACTIVE|INACTIVE|UNKNOWN|NOT_ANSWERED|REFUSED)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Result"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 500,
              "maximum": 1000,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            },
            "example": 500
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 200,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            }
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilityBatchRowsPage"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_wgpejzf64n23xb12q04c",
                  "batch_id": "bat_4eghyt58pn73b6ezzxy2",
                  "rows": [
                    {
                      "index": 0,
                      "reference": "appt-1001",
                      "facility_id": "fac_sandboxbatchsandbx",
                      "state": "DONE",
                      "http_status": 200,
                      "eligibility_id": "elg_de0skc6wkd6kv70zeyxv",
                      "status": "ACTIVE",
                      "error": null,
                      "message": null,
                      "idempotent_replay": false,
                      "billing": {
                        "charged": false,
                        "label": "Test mode",
                        "reason": "test_mode",
                        "reason_label": "Test mode checks never reach a payer and are never charged",
                        "state": "NOT_BILLABLE",
                        "unit_price_micros": null
                      },
                      "rejection": null,
                      "problems": null,
                      "payer": {
                        "input": "94276",
                        "payer_id": "94276",
                        "payer_name": "Delta Dental",
                        "state": "EXACT"
                      },
                      "duplicate_of": null,
                      "attempts": 1,
                      "next_try_at": null
                    },
                    {
                      "index": 1,
                      "reference": "appt-1002",
                      "facility_id": "fac_sandboxbatchsandbx",
                      "state": "DONE",
                      "http_status": 200,
                      "eligibility_id": "elg_pr6kqzt8696yz41d720w",
                      "status": "INACTIVE",
                      "error": null,
                      "message": null,
                      "idempotent_replay": false,
                      "billing": {
                        "charged": false,
                        "label": "Test mode",
                        "reason": "test_mode",
                        "reason_label": "Test mode checks never reach a payer and are never charged",
                        "state": "NOT_BILLABLE",
                        "unit_price_micros": null
                      },
                      "rejection": null,
                      "problems": null,
                      "payer": {
                        "input": "94276",
                        "payer_id": "94276",
                        "payer_name": "Delta Dental",
                        "state": "EXACT"
                      },
                      "duplicate_of": null,
                      "attempts": 1,
                      "next_try_at": null
                    }
                  ],
                  "next_cursor": "eyJhIjoxLCJjIjoiZjBlNmM0YjUzOTQ0ODkzZiJ9"
                }
              }
            },
            "description": "One page of rows",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List a batch's rows",
        "tags": [
          "eligibility"
        ]
      }
    },
    "/v1/eligibility/{eligibility_id}": {
      "get": {
        "operationId": "getEligibilityCheck",
        "parameters": [
          {
            "in": "path",
            "name": "eligibility_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Eligibility Id",
              "type": "string"
            },
            "example": "elg_hp130jp45188vw4wk5tz"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EligibilityRecordV3"
                    },
                    {
                      "$ref": "#/components/schemas/EligibilityReadResponse"
                    }
                  ]
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_jbarbayqk15kqdkn80w7",
                  "id": "elg_9aqbap922506q92gx9ge",
                  "contract": "eligibility.v3",
                  "view": "complete",
                  "status": "active",
                  "checked_at": "2026-09-07T15:00:00+00:00",
                  "verified": true,
                  "office": {
                    "id": "fac_sandboxbatchsandbx",
                    "name": "fac_sandboxbatchsandbx"
                  },
                  "payer": {
                    "id": "94276",
                    "name": "Delta Dental",
                    "id_as_returned": "94276",
                    "name_as_returned": "Delta Dental"
                  },
                  "patient": {
                    "date_of_birth": "1980-01-01",
                    "first_name": "TEST",
                    "last_name": "PATIENT",
                    "member_id": "CH-ACTIVE-FULL",
                    "relationship": "self"
                  },
                  "as_requested": {
                    "subscriber": {
                      "first_name": "Test",
                      "last_name": "Patient",
                      "date_of_birth": "1980-01-01",
                      "member_id": "CH-ACTIVE-FULL"
                    },
                    "relationship": "self",
                    "visit_date": "2026-09-07",
                    "differences": [],
                    "not_returned": [
                      "subscriber"
                    ]
                  },
                  "plan": {
                    "group_number": "TESTGRP1",
                    "insurance_type": "ppo",
                    "name": "Delta Dental PPO",
                    "coverage": {
                      "start": "2026-01-01",
                      "status": "active",
                      "termination": "2026-12-31",
                      "lines": [
                        {
                          "kind": "active_coverage",
                          "network": "in_network",
                          "insurance_type": "group_policy",
                          "text": "In network, group policy: active coverage",
                          "ref": "active_coverage[0]"
                        }
                      ]
                    }
                  },
                  "totals": {
                    "deductibles": [
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "individual",
                        "period": "calendar",
                        "service": "dental_care",
                        "amount": "50.00",
                        "text": "Dental care (general), in network, individual, calendar year: deductible $50.00",
                        "ref": "deductible[0]"
                      },
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "individual",
                        "period": "remaining",
                        "service": "dental_care",
                        "amount": "25.00",
                        "text": "Dental care (general), in network, individual, remaining: deductible $25.00",
                        "ref": "deductible[1]"
                      },
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "family",
                        "period": "calendar",
                        "service": "dental_care",
                        "amount": "150.00",
                        "text": "Dental care (general), in network, family, calendar year: deductible $150.00",
                        "ref": "deductible[2]"
                      },
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "family",
                        "period": "remaining",
                        "service": "dental_care",
                        "amount": "150.00",
                        "text": "Dental care (general), in network, family, remaining: deductible $150.00",
                        "ref": "deductible[3]"
                      }
                    ],
                    "maximums": [
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "calendar",
                        "service": "dental_care",
                        "amount": "1500.00",
                        "text": "Dental care (general), in network, individual, calendar year: maximum $1500.00",
                        "ref": "maximums[0]"
                      },
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "remaining",
                        "service": "dental_care",
                        "amount": "1200.00",
                        "text": "Dental care (general), in network, individual, remaining: maximum $1200.00",
                        "ref": "maximums[1]"
                      },
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "lifetime",
                        "service": "orthodontics",
                        "amount": "1000.00",
                        "text": "Orthodontics, in network, individual, lifetime: maximum $1000.00",
                        "ref": "maximums[2]"
                      },
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "lifetime_remaining",
                        "service": "orthodontics",
                        "amount": "1000.00",
                        "text": "Orthodontics, in network, individual, lifetime remaining: maximum $1000.00",
                        "ref": "maximums[3]"
                      }
                    ]
                  },
                  "by_service": [
                    {
                      "service": "preventive",
                      "label": "Preventive care",
                      "lines": [
                        {
                          "kind": "coinsurance",
                          "network": "in_network",
                          "percent": 100,
                          "text": "Preventive care, in network: coinsurance 100%",
                          "ref": "coinsurance[0]"
                        }
                      ]
                    },
                    {
                      "service": "restorative",
                      "label": "Restorative (fillings)",
                      "lines": [
                        {
                          "kind": "coinsurance",
                          "network": "in_network",
                          "percent": 80,
                          "text": "Restorative (fillings), in network: coinsurance 80%",
                          "ref": "coinsurance[1]"
                        }
                      ]
                    },
                    {
                      "service": "dental_crowns",
                      "label": "Crowns",
                      "lines": [
                        {
                          "kind": "coinsurance",
                          "network": "in_network",
                          "percent": 50,
                          "text": "Crowns, in network: coinsurance 50%",
                          "ref": "coinsurance[2]"
                        }
                      ]
                    }
                  ],
                  "by_procedure": [
                    {
                      "code": "D0274",
                      "code_as_sent": "AD:D0274",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 visits in 12 month",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "month",
                              "time_period_value": "12"
                            }
                          ],
                          "text": "D0274, all networks, individual: limitation 1 visits in 12 month (frequency 1 visits per 12 months)",
                          "ref": "limitations[2]"
                        },
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 units remaining",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "units",
                              "time_period_qualifier": "remaining"
                            }
                          ],
                          "text": "D0274, all networks, individual: limitation 1 units remaining (frequency 1 units, time period remaining)",
                          "ref": "limitations[3]"
                        }
                      ]
                    },
                    {
                      "code": "D1110",
                      "code_as_sent": "AD:D1110",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "2 visits in 1 calendar",
                          "frequency": [
                            {
                              "quantity": "2",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "calendar",
                              "time_period_value": "1"
                            }
                          ],
                          "text": "D1110, all networks, individual: limitation 2 visits in 1 calendar (frequency 2 visits per calendar year)",
                          "ref": "limitations[0]"
                        },
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 units remaining",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "units",
                              "time_period_qualifier": "remaining"
                            }
                          ],
                          "text": "D1110, all networks, individual: limitation 1 units remaining (frequency 1 units, time period remaining)",
                          "ref": "limitations[1]"
                        }
                      ]
                    }
                  ],
                  "missing": [
                    "not_covered",
                    "waiting_period"
                  ],
                  "not_read": [],
                  "labels": {
                    "network": {
                      "applies_all": "All networks",
                      "in_network": "In network"
                    },
                    "level": {
                      "family": "Family",
                      "individual": "Individual"
                    },
                    "period": {
                      "calendar": "Calendar year",
                      "lifetime": "Lifetime",
                      "lifetime_remaining": "Lifetime remaining",
                      "remaining": "Remaining"
                    },
                    "service": {
                      "dental_care": "Dental care (general)",
                      "dental_crowns": "Crowns",
                      "orthodontics": "Orthodontics",
                      "preventive": "Preventive care",
                      "restorative": "Restorative (fillings)"
                    },
                    "insurance_type": {
                      "group_policy": "Group policy",
                      "ppo": "PPO"
                    }
                  },
                  "counts": {
                    "payer_rows": 16,
                    "lines": 16,
                    "procedures": 2,
                    "notes": 0,
                    "history": 0
                  },
                  "links": {
                    "complete": "/v1/eligibility/elg_9aqbap922506q92gx9ge/answer?contract=v3",
                    "summary": "/v1/eligibility/elg_9aqbap922506q92gx9ge/answer?contract=v3&view=summary",
                    "lines": "/v1/eligibility/elg_9aqbap922506q92gx9ge/answer?contract=v3&view=lines",
                    "payer_answer": "/v1/eligibility/elg_9aqbap922506q92gx9ge/answer?view=payer",
                    "pdf": "/v1/eligibility/elg_9aqbap922506q92gx9ge/pdf"
                  },
                  "billing": {
                    "charged": false,
                    "state": "NOT_BILLABLE",
                    "reason": "test_mode",
                    "label": "Test mode",
                    "reason_label": "Test mode checks never reach a payer and are never charged"
                  },
                  "request": {
                    "idempotency_key": "first-check-ab12cd"
                  }
                }
              }
            },
            "description": "The check. API version 2026-11-01 (the default): the answer, contract eligibility.v3 (EligibilityRecordV3). Pinned to 2026-10-01: the check record (EligibilityReadResponse).",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Get an eligibility answer",
        "tags": [
          "eligibility"
        ],
        "description": "Read one check: its organized answer, what it cost and what was sent."
      }
    },
    "/v1/eligibility/{eligibility_id}/answer": {
      "get": {
        "description": "The payer's answer, complete and readable (contract ``eligibility.v2``).\n\n``view=readable`` (the default): each payer value carried exactly as\nsent, with plain labels and one plain line beside it; ``truth`` reports\nthe gates that proved the plain lines against the answer. Built once and\nstored; every read checks the stored copy's sha256. ``view=payer``:\nthe source projection in ``payer_answer``, with excluded transport metadata\nremoved (not original archive bytes; source format may vary).\n``view=full``: both. ``ETag`` names the version served; a matching\n``If-None-Match`` answers 304. Never cached by a browser (``no-store``).\n\n``contract=v3`` (or ``view=complete|summary|lines``) serves the\norganized answer, contract ``eligibility.v3``: ``complete``\n(``readable`` reads as ``complete`` under v3), ``summary`` (``fields=``\nnarrows it by block and CDT code), ``lines`` or ``payer``. Under API\nversion 2026-11-01 (the default) ``eligibility.v3`` is the default\ncontract and ``contract=v2`` serves the v2 answer; under 2026-10-01 the\ndefault stays ``eligibility.v2``.",
        "operationId": "getEligibilityAnswer",
        "parameters": [
          {
            "in": "path",
            "name": "eligibility_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Eligibility Id",
              "type": "string"
            },
            "example": "elg_EXAMPLE0000000000000001"
          },
          {
            "in": "query",
            "name": "view",
            "required": false,
            "schema": {
              "default": "readable",
              "pattern": "^(readable|payer|full|complete|summary|lines)$",
              "title": "View",
              "type": "string"
            },
            "example": "summary"
          },
          {
            "in": "query",
            "name": "contract",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(v2|v3|eligibility\\.v2|eligibility\\.v3)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Contract"
            },
            "example": "v3"
          },
          {
            "in": "query",
            "name": "fields",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 2000,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Fields"
            },
            "example": "totals,D1110"
          },
          {
            "in": "header",
            "name": "If-None-Match",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 1024,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "If-None-Match"
            },
            "example": "\"3f9a0c1d7e2b4a6c8d0e1f2a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e\""
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EligibilityAnswerV3"
                    },
                    {
                      "$ref": "#/components/schemas/EligibilityFullAnswer"
                    },
                    {
                      "$ref": "#/components/schemas/EligibilityReadableAnswer"
                    },
                    {
                      "$ref": "#/components/schemas/EligibilityPayerAnswer"
                    }
                  ]
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_aszh2ntab12qze3beasn",
                  "id": "elg_ztnbv2mkpn10d0qxy1yj",
                  "contract": "eligibility.v3",
                  "view": "complete",
                  "status": "active",
                  "checked_at": "2026-09-07T15:00:00+00:00",
                  "verified": true,
                  "office": {
                    "id": "fac_sandboxbatchsandbx",
                    "name": "fac_sandboxbatchsandbx"
                  },
                  "payer": {
                    "id": "94276",
                    "name": "Delta Dental",
                    "id_as_returned": "94276",
                    "name_as_returned": "Delta Dental"
                  },
                  "patient": {
                    "date_of_birth": "1970-01-10",
                    "first_name": "AVERY",
                    "last_name": "MOLAR",
                    "member_id": "CH-ACTIVE-RICH",
                    "relationship": "self"
                  },
                  "as_requested": {
                    "subscriber": {
                      "first_name": "Avery",
                      "last_name": "Molar",
                      "date_of_birth": "1970-01-10",
                      "member_id": "CH-ACTIVE-RICH"
                    },
                    "relationship": "self",
                    "visit_date": "2026-09-07",
                    "differences": [],
                    "not_returned": [
                      "subscriber"
                    ]
                  },
                  "plan": {
                    "group_number": "TESTGRP1",
                    "insurance_type": "ppo",
                    "name": "Delta Dental PPO",
                    "coverage": {
                      "start": "2026-01-01",
                      "status": "active",
                      "termination": "2026-12-31",
                      "lines": [
                        {
                          "kind": "active_coverage",
                          "network": "in_network",
                          "insurance_type": "group_policy",
                          "text": "In network, group policy: active coverage",
                          "ref": "active_coverage[0]"
                        }
                      ]
                    }
                  },
                  "totals": {
                    "deductibles": [
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "individual",
                        "period": "calendar",
                        "service": "dental_care",
                        "amount": "50.00",
                        "text": "Dental care (general), in network, individual, calendar year: deductible $50.00",
                        "ref": "deductible[0]"
                      },
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "individual",
                        "period": "remaining",
                        "service": "dental_care",
                        "amount": "25.00",
                        "text": "Dental care (general), in network, individual, remaining: deductible $25.00",
                        "ref": "deductible[1]"
                      },
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "family",
                        "period": "calendar",
                        "service": "dental_care",
                        "amount": "150.00",
                        "text": "Dental care (general), in network, family, calendar year: deductible $150.00",
                        "ref": "deductible[2]"
                      },
                      {
                        "kind": "deductible",
                        "network": "in_network",
                        "level": "family",
                        "period": "remaining",
                        "service": "dental_care",
                        "amount": "150.00",
                        "text": "Dental care (general), in network, family, remaining: deductible $150.00",
                        "ref": "deductible[3]"
                      }
                    ],
                    "maximums": [
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "calendar",
                        "service": "dental_care",
                        "amount": "1500.00",
                        "text": "Dental care (general), in network, individual, calendar year: maximum $1500.00",
                        "ref": "maximums[0]"
                      },
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "remaining",
                        "service": "dental_care",
                        "amount": "1200.00",
                        "text": "Dental care (general), in network, individual, remaining: maximum $1200.00",
                        "ref": "maximums[1]"
                      },
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "lifetime",
                        "service": "orthodontics",
                        "amount": "1500.00",
                        "text": "Orthodontics, in network, individual, lifetime: maximum $1500.00",
                        "ref": "maximums[2]"
                      },
                      {
                        "kind": "maximum",
                        "network": "in_network",
                        "level": "individual",
                        "period": "lifetime_remaining",
                        "service": "orthodontics",
                        "amount": "1500.00",
                        "text": "Orthodontics, in network, individual, lifetime remaining: maximum $1500.00",
                        "ref": "maximums[3]"
                      }
                    ]
                  },
                  "by_service": [
                    {
                      "service": "preventive",
                      "label": "Preventive care",
                      "lines": [
                        {
                          "kind": "coinsurance",
                          "network": "in_network",
                          "percent": 100,
                          "text": "Preventive care, in network: coinsurance 100%",
                          "ref": "coinsurance[0]"
                        }
                      ]
                    },
                    {
                      "service": "restorative",
                      "label": "Restorative (fillings)",
                      "lines": [
                        {
                          "kind": "coinsurance",
                          "network": "in_network",
                          "percent": 80,
                          "text": "Restorative (fillings), in network: coinsurance 80%",
                          "ref": "coinsurance[1]"
                        }
                      ]
                    },
                    {
                      "service": "dental_crowns",
                      "label": "Crowns",
                      "lines": [
                        {
                          "kind": "coinsurance",
                          "network": "in_network",
                          "percent": 50,
                          "text": "Crowns, in network: coinsurance 50%",
                          "ref": "coinsurance[2]"
                        }
                      ]
                    }
                  ],
                  "by_procedure": [
                    {
                      "code": "D0120",
                      "code_as_sent": "AD:D0120",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "2 visits in 1 calendar",
                          "frequency": [
                            {
                              "quantity": "2",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "calendar",
                              "time_period_value": "1"
                            }
                          ],
                          "service_dates": [
                            {
                              "latest_visit_or_consultation": "03/14/2026",
                              "service_date": "03/14/2026",
                              "type": "latest_visit_or_consultation",
                              "value": "03/14/2026"
                            }
                          ],
                          "text": "D0120, all networks, individual: limitation 2 visits in 1 calendar (frequency 2 visits per calendar year; last visit 03/14/2026)",
                          "ref": "limitations[0]"
                        },
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 units remaining",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "units",
                              "time_period_qualifier": "remaining"
                            }
                          ],
                          "service_dates": [
                            {
                              "latest_visit_or_consultation": "03/14/2026",
                              "service_date": "03/14/2026",
                              "type": "latest_visit_or_consultation",
                              "value": "03/14/2026"
                            }
                          ],
                          "text": "D0120, all networks, individual: limitation 1 units remaining (frequency 1 units, time period remaining; last visit 03/14/2026)",
                          "ref": "limitations[1]"
                        }
                      ],
                      "history": [
                        {
                          "type": "latest_visit_or_consultation",
                          "date": "2026-03-14",
                          "ref": "limitations[0].service_dates[0]"
                        },
                        {
                          "type": "latest_visit_or_consultation",
                          "date": "2026-03-14",
                          "ref": "limitations[1].service_dates[0]"
                        }
                      ]
                    },
                    {
                      "code": "D0150",
                      "code_as_sent": "AD:D0150",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 visits in 36 month",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "month",
                              "time_period_value": "36"
                            }
                          ],
                          "service_dates": [
                            {
                              "latest_visit_or_consultation": "05/20/2024",
                              "service_date": "05/20/2024",
                              "type": "latest_visit_or_consultation",
                              "value": "05/20/2024"
                            }
                          ],
                          "text": "D0150, all networks, individual: limitation 1 visits in 36 month (frequency 1 visits per 36 months; last visit 05/20/2024)",
                          "ref": "limitations[2]"
                        }
                      ],
                      "history": [
                        {
                          "type": "latest_visit_or_consultation",
                          "date": "2024-05-20",
                          "ref": "limitations[2].service_dates[0]"
                        }
                      ]
                    },
                    {
                      "code": "D0274",
                      "code_as_sent": "AD:D0274",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 visits in 12 month",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "month",
                              "time_period_value": "12"
                            }
                          ],
                          "service_dates": [
                            {
                              "latest_visit_or_consultation": "03/14/2026",
                              "service_date": "03/14/2026",
                              "type": "latest_visit_or_consultation",
                              "value": "03/14/2026"
                            }
                          ],
                          "text": "D0274, all networks, individual: limitation 1 visits in 12 month (frequency 1 visits per 12 months; last visit 03/14/2026)",
                          "ref": "limitations[3]"
                        },
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "0 units remaining",
                          "frequency": [
                            {
                              "quantity": "0",
                              "quantity_qualifier": "units",
                              "time_period_qualifier": "remaining"
                            }
                          ],
                          "service_dates": [
                            {
                              "latest_visit_or_consultation": "03/14/2026",
                              "service_date": "03/14/2026",
                              "type": "latest_visit_or_consultation",
                              "value": "03/14/2026"
                            }
                          ],
                          "text": "D0274, all networks, individual: limitation 0 units remaining (frequency 0 units, time period remaining; last visit 03/14/2026)",
                          "ref": "limitations[4]"
                        }
                      ],
                      "history": [
                        {
                          "type": "latest_visit_or_consultation",
                          "date": "2026-03-14",
                          "ref": "limitations[3].service_dates[0]"
                        },
                        {
                          "type": "latest_visit_or_consultation",
                          "date": "2026-03-14",
                          "ref": "limitations[4].service_dates[0]"
                        }
                      ]
                    },
                    {
                      "code": "D0330",
                      "code_as_sent": "AD:D0330",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 visits in 60 month",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "month",
                              "time_period_value": "60"
                            }
                          ],
                          "service_dates": [
                            {
                              "latest_visit_or_consultation": "06/02/2022",
                              "service_date": "06/02/2022",
                              "type": "latest_visit_or_consultation",
                              "value": "06/02/2022"
                            }
                          ],
                          "text": "D0330, all networks, individual: limitation 1 visits in 60 month (frequency 1 visits per 60 months; last visit 06/02/2022)",
                          "ref": "limitations[5]"
                        }
                      ],
                      "history": [
                        {
                          "type": "latest_visit_or_consultation",
                          "date": "2022-06-02",
                          "ref": "limitations[5].service_dates[0]"
                        }
                      ]
                    },
                    {
                      "code": "D1110",
                      "code_as_sent": "AD:D1110",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "2 visits in 1 calendar",
                          "frequency": [
                            {
                              "quantity": "2",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "calendar",
                              "time_period_value": "1"
                            }
                          ],
                          "service_dates": [
                            {
                              "latest_visit_or_consultation": "03/14/2026",
                              "service_date": "03/14/2026",
                              "type": "latest_visit_or_consultation",
                              "value": "03/14/2026"
                            }
                          ],
                          "text": "D1110, all networks, individual: limitation 2 visits in 1 calendar (frequency 2 visits per calendar year; last visit 03/14/2026)",
                          "ref": "limitations[6]"
                        },
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 units remaining",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "units",
                              "time_period_qualifier": "remaining"
                            }
                          ],
                          "service_dates": [
                            {
                              "latest_visit_or_consultation": "03/14/2026",
                              "service_date": "03/14/2026",
                              "type": "latest_visit_or_consultation",
                              "value": "03/14/2026"
                            }
                          ],
                          "text": "D1110, all networks, individual: limitation 1 units remaining (frequency 1 units, time period remaining; last visit 03/14/2026)",
                          "ref": "limitations[7]"
                        }
                      ],
                      "history": [
                        {
                          "type": "latest_visit_or_consultation",
                          "date": "2026-03-14",
                          "ref": "limitations[6].service_dates[0]"
                        },
                        {
                          "type": "latest_visit_or_consultation",
                          "date": "2026-03-14",
                          "ref": "limitations[7].service_dates[0]"
                        }
                      ]
                    },
                    {
                      "code": "D1206",
                      "code_as_sent": "AD:D1206",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "2 visits in 1 calendar",
                          "frequency": [
                            {
                              "quantity": "2",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "calendar",
                              "time_period_value": "1"
                            }
                          ],
                          "text": "D1206, all networks, individual: limitation 2 visits in 1 calendar (frequency 2 visits per calendar year)",
                          "ref": "limitations[8]"
                        },
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "quantity": "19",
                          "quantity_unit": "age_high_value",
                          "age": {
                            "age_high_value": "19"
                          },
                          "text": "D1206, all networks, individual: limitation (quantity 19 maximum age; through age 19)",
                          "ref": "limitations[9]"
                        }
                      ]
                    },
                    {
                      "code": "D2391",
                      "code_as_sent": "AD:D2391",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 visits in 24 month",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "month",
                              "time_period_value": "24"
                            }
                          ],
                          "service_dates": [
                            {
                              "latest_visit_or_consultation": "01/17/2025",
                              "service_date": "01/17/2025",
                              "type": "latest_visit_or_consultation",
                              "value": "01/17/2025"
                            }
                          ],
                          "note": "Per surface. Last service on tooth 30",
                          "text": "D2391, all networks, individual: limitation 1 visits in 24 month (frequency 1 visits per 24 months; last visit 01/17/2025; payer note: Per surface. Last service on tooth 30)",
                          "ref": "limitations[13]"
                        }
                      ],
                      "history": [
                        {
                          "type": "latest_visit_or_consultation",
                          "date": "2025-01-17",
                          "ref": "limitations[13].service_dates[0]"
                        }
                      ]
                    },
                    {
                      "code": "D2740",
                      "code_as_sent": "AD:D2740",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 visits in 60 month",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "month",
                              "time_period_value": "60"
                            }
                          ],
                          "service_dates": [
                            {
                              "latest_visit_or_consultation": "04/11/2021",
                              "service_date": "04/11/2021",
                              "type": "latest_visit_or_consultation",
                              "value": "04/11/2021"
                            }
                          ],
                          "note": "Per tooth. Last service on tooth 3",
                          "text": "D2740, all networks, individual: limitation 1 visits in 60 month (frequency 1 visits per 60 months; last visit 04/11/2021; payer note: Per tooth. Last service on tooth 3)",
                          "ref": "limitations[11]"
                        }
                      ],
                      "history": [
                        {
                          "type": "latest_visit_or_consultation",
                          "date": "2021-04-11",
                          "ref": "limitations[11].service_dates[0]"
                        }
                      ]
                    },
                    {
                      "code": "D3330",
                      "code_as_sent": "AD:D3330",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "1 visits in lifetime",
                          "frequency": [
                            {
                              "quantity": "1",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "lifetime"
                            }
                          ],
                          "service_dates": [
                            {
                              "latest_visit_or_consultation": "08/09/2023",
                              "service_date": "08/09/2023",
                              "type": "latest_visit_or_consultation",
                              "value": "08/09/2023"
                            }
                          ],
                          "note": "Per tooth. Last service on tooth 19",
                          "text": "D3330, all networks, individual: limitation 1 visits in lifetime (frequency 1 visits per lifetime; last visit 08/09/2023; payer note: Per tooth. Last service on tooth 19)",
                          "ref": "limitations[12]"
                        }
                      ],
                      "history": [
                        {
                          "type": "latest_visit_or_consultation",
                          "date": "2023-08-09",
                          "ref": "limitations[12].service_dates[0]"
                        }
                      ]
                    },
                    {
                      "code": "D4910",
                      "code_as_sent": "AD:D4910",
                      "lines": [
                        {
                          "kind": "limitation",
                          "network": "applies_all",
                          "level": "individual",
                          "limit": "4 visits in 1 calendar",
                          "frequency": [
                            {
                              "quantity": "4",
                              "quantity_qualifier": "visits",
                              "time_period_qualifier": "calendar",
                              "time_period_value": "1"
                            }
                          ],
                          "text": "D4910, all networks, individual: limitation 4 visits in 1 calendar (frequency 4 visits per calendar year)",
                          "ref": "limitations[10]"
                        }
                      ]
                    }
                  ],
                  "history": [
                    {
                      "code": "D0120",
                      "type": "latest_visit_or_consultation",
                      "date": "2026-03-14",
                      "ref": "limitations[0].service_dates[0]"
                    },
                    {
                      "code": "D0120",
                      "type": "latest_visit_or_consultation",
                      "date": "2026-03-14",
                      "ref": "limitations[1].service_dates[0]"
                    },
                    {
                      "code": "D0274",
                      "type": "latest_visit_or_consultation",
                      "date": "2026-03-14",
                      "ref": "limitations[3].service_dates[0]"
                    },
                    {
                      "code": "D0274",
                      "type": "latest_visit_or_consultation",
                      "date": "2026-03-14",
                      "ref": "limitations[4].service_dates[0]"
                    },
                    {
                      "code": "D1110",
                      "type": "latest_visit_or_consultation",
                      "date": "2026-03-14",
                      "ref": "limitations[6].service_dates[0]"
                    },
                    {
                      "code": "D1110",
                      "type": "latest_visit_or_consultation",
                      "date": "2026-03-14",
                      "ref": "limitations[7].service_dates[0]"
                    },
                    {
                      "code": "D2391",
                      "type": "latest_visit_or_consultation",
                      "date": "2025-01-17",
                      "ref": "limitations[13].service_dates[0]"
                    },
                    {
                      "code": "D0150",
                      "type": "latest_visit_or_consultation",
                      "date": "2024-05-20",
                      "ref": "limitations[2].service_dates[0]"
                    },
                    {
                      "code": "D3330",
                      "type": "latest_visit_or_consultation",
                      "date": "2023-08-09",
                      "ref": "limitations[12].service_dates[0]"
                    },
                    {
                      "code": "D0330",
                      "type": "latest_visit_or_consultation",
                      "date": "2022-06-02",
                      "ref": "limitations[5].service_dates[0]"
                    },
                    {
                      "code": "D2740",
                      "type": "latest_visit_or_consultation",
                      "date": "2021-04-11",
                      "ref": "limitations[11].service_dates[0]"
                    }
                  ],
                  "missing": [
                    "not_covered",
                    "waiting_period"
                  ],
                  "not_read": [],
                  "labels": {
                    "network": {
                      "applies_all": "All networks",
                      "in_network": "In network"
                    },
                    "level": {
                      "family": "Family",
                      "individual": "Individual"
                    },
                    "period": {
                      "calendar": "Calendar year",
                      "lifetime": "Lifetime",
                      "lifetime_remaining": "Lifetime remaining",
                      "remaining": "Remaining"
                    },
                    "service": {
                      "dental_care": "Dental care (general)",
                      "dental_crowns": "Crowns",
                      "orthodontics": "Orthodontics",
                      "preventive": "Preventive care",
                      "restorative": "Restorative (fillings)"
                    },
                    "quantity_unit": {
                      "age_high_value": "maximum age"
                    },
                    "insurance_type": {
                      "group_policy": "Group policy",
                      "ppo": "PPO"
                    }
                  },
                  "counts": {
                    "payer_rows": 26,
                    "lines": 26,
                    "procedures": 10,
                    "notes": 0,
                    "history": 11
                  },
                  "links": {
                    "complete": "/v1/eligibility/elg_ztnbv2mkpn10d0qxy1yj/answer?contract=v3",
                    "summary": "/v1/eligibility/elg_ztnbv2mkpn10d0qxy1yj/answer?contract=v3&view=summary",
                    "lines": "/v1/eligibility/elg_ztnbv2mkpn10d0qxy1yj/answer?contract=v3&view=lines",
                    "payer_answer": "/v1/eligibility/elg_ztnbv2mkpn10d0qxy1yj/answer?view=payer",
                    "pdf": "/v1/eligibility/elg_ztnbv2mkpn10d0qxy1yj/pdf"
                  }
                }
              }
            },
            "description": "The representation selected by contract and view. Contract eligibility.v3 (the default under API version 2026-11-01): complete, summary, lines or payer. Contract eligibility.v2 (the default under 2026-10-01): readable, full or payer.",
            "headers": {
              "Cache-Control": {
                "schema": {
                  "type": "string"
                }
              },
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              },
              "ETag": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "304": {
            "description": "The selected representation has not changed; no response body.",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Read the payer's answer",
        "tags": [
          "eligibility"
        ]
      }
    },
    "/v1/eligibility/{eligibility_id}/operation": {
      "get": {
        "operationId": "getEligibilityOperation",
        "parameters": [
          {
            "in": "path",
            "name": "eligibility_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Eligibility Id",
              "type": "string"
            },
            "example": "elg_EXAMPLE0000000000000001"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilityOperation"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_00z0kmw3d10pf70mxq0f",
                  "eligibility_id": "elg_cz2zee1eeh3tb79rxc58",
                  "facility_id": "fac_sandboxsandboxsand",
                  "environment": "test",
                  "state": "COMPLETE",
                  "response_mode": "standard",
                  "result_id": "elg_cz2zee1eeh3tb79rxc58",
                  "request_archived": true,
                  "response_archived": true,
                  "pdf": null
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Poll an eligibility operation",
        "tags": [
          "eligibility"
        ],
        "description": "Poll the state of one eligibility request, including archive and PDF status."
      }
    },
    "/v1/eligibility/{eligibility_id}/pdf": {
      "get": {
        "description": "The PDF already made for this check's current answer, with a short-lived download URL.\n\nNeeds only ``read``. Never makes a PDF: ``404 PDF_NOT_MADE`` until\n``POST /v1/eligibility/{eligibility_id}/pdf`` has made one of the same kind. No render, no\nevent, no charge. ``kind=complete`` (the default under 2026-11-01) or ``kind=streamlined``;\n``contract=v2`` reads the 2026-10-01 PDF (that version's default), ``contract=v3`` is\n``kind=complete``.",
        "operationId": "getEligibilityPdf",
        "parameters": [
          {
            "in": "path",
            "name": "eligibility_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Eligibility Id",
              "type": "string"
            },
            "example": "elg_hp130jp45188vw4wk5tz"
          },
          {
            "description": "complete (the default under API version 2026-11-01): every line of the answer, as long as the answer is, in a compact layout. streamlined: the lines the summary view selects (the office's saved summary settings, else the default), marked N of M lines.",
            "in": "query",
            "name": "kind",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(complete|streamlined)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "complete (the default under API version 2026-11-01): every line of the answer, as long as the answer is, in a compact layout. streamlined: the lines the summary view selects (the office's saved summary settings, else the default), marked N of M lines.",
              "title": "Kind"
            },
            "example": "streamlined"
          },
          {
            "description": "v2: the 2026-10-01 PDF (the default under that version). v3: the complete PDF, the same as kind=complete.",
            "in": "query",
            "name": "contract",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(v2|v3|eligibility\\.v2|eligibility\\.v3)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "v2: the 2026-10-01 PDF (the default under that version). v3: the complete PDF, the same as kind=complete.",
              "title": "Contract"
            },
            "example": "v3"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilityPdfDownload"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_mxrzjwfm6h5mn430pty0",
                  "eligibility_id": "elg_m6ty5a8j8s4156mq1bs7",
                  "artifact_id": "art_pxwvrtatv14dq6kw8mmp",
                  "filename": "elig_elg_m6ty5a8j8s4156mq1bs7-complete.pdf",
                  "bytes": 90033,
                  "contract": "eligibility.v3",
                  "kind": "complete",
                  "download_url": "https://files.claimhouse.ai/EXAMPLE-short-lived-link",
                  "expires_in_seconds": 600
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Get the PDF of a check",
        "tags": [
          "eligibility"
        ]
      },
      "post": {
        "description": "Make the PDF for this check's answer from the stored payer answer.\n\nStores the PDF in the artifact store only (no OpenDental upload). Returns\n``artifact_id`` for ``GET /v1/artifacts/{artifact_id}``. Under API version\n2026-11-01 the default is ``kind=complete`` (``elig_{eligibility_id}-complete.pdf``,\nevery line of the answer); ``kind=streamlined`` makes the summary view's PDF\n(``elig_{eligibility_id}-streamlined.pdf``); both answer ``contract: eligibility.v3``\nand ``kind``. Under 2026-10-01 the default is the 2026-10-01 PDF\n(``elig_{eligibility_id}.pdf``), unchanged; ``contract=v3`` is ``kind=complete``.\nEach kind is its own artifact and never replaces another.",
        "operationId": "generateEligibilityPdf",
        "parameters": [
          {
            "in": "path",
            "name": "eligibility_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Eligibility Id",
              "type": "string"
            },
            "example": "elg_hp130jp45188vw4wk5tz"
          },
          {
            "description": "complete (the default under API version 2026-11-01): every line of the answer, as long as the answer is, in a compact layout. streamlined: the lines the summary view selects (the office's saved summary settings, else the default), marked N of M lines.",
            "in": "query",
            "name": "kind",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(complete|streamlined)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "complete (the default under API version 2026-11-01): every line of the answer, as long as the answer is, in a compact layout. streamlined: the lines the summary view selects (the office's saved summary settings, else the default), marked N of M lines.",
              "title": "Kind"
            },
            "example": "streamlined"
          },
          {
            "description": "v2: the 2026-10-01 PDF (the default under that version). v3: the complete PDF, the same as kind=complete.",
            "in": "query",
            "name": "contract",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(v2|v3|eligibility\\.v2|eligibility\\.v3)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "v2: the 2026-10-01 PDF (the default under that version). v3: the complete PDF, the same as kind=complete.",
              "title": "Contract"
            },
            "example": "v3"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilityPdfCreated"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_5hd70es8253wbbg47xye",
                  "eligibility_id": "elg_m6ty5a8j8s4156mq1bs7",
                  "artifact_id": "art_pxwvrtatv14dq6kw8mmp",
                  "filename": "elig_elg_m6ty5a8j8s4156mq1bs7-complete.pdf",
                  "bytes": 90033,
                  "contract": "eligibility.v3",
                  "kind": "complete"
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Create an eligibility PDF",
        "tags": [
          "eligibility"
        ]
      }
    },
    "/v1/facilities": {
      "get": {
        "operationId": "listFacilities",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FacilityList"
                },
                "example": {
                  "request_id": "evt_j912jjpyq90stk2r84g5",
                  "facilities": [
                    {
                      "facility_id": "fac_q5s09nzww25ysd5a2f3g",
                      "name": "HAL",
                      "group_id": null,
                      "billing_npi": "9999999995",
                      "tin_type": "EI",
                      "taxonomy": "1223G0001X",
                      "control_prefix": "HAL",
                      "claim_office_code": null,
                      "claim_timezone": null,
                      "nea_facility_id": null,
                      "binding_kind": "production",
                      "status": "ACTIVE",
                      "display_name": null,
                      "legal_name": null,
                      "address_line1": null,
                      "address_line2": null,
                      "city": null,
                      "state": null,
                      "postal_code": null,
                      "country": null,
                      "contact_name": null,
                      "contact_email": null,
                      "contact_phone": null,
                      "partner_office_ref": null,
                      "profile_source": null,
                      "profile_version": null,
                      "identity_review_status": null
                    },
                    {
                      "facility_id": "fac_w9qxypnbcw7b308jbbhh",
                      "name": "HA2",
                      "group_id": null,
                      "billing_npi": "9999999995",
                      "tin_type": "EI",
                      "taxonomy": "1223G0001X",
                      "control_prefix": "HA2",
                      "claim_office_code": null,
                      "claim_timezone": null,
                      "nea_facility_id": null,
                      "binding_kind": "production",
                      "status": "ACTIVE",
                      "display_name": null,
                      "legal_name": null,
                      "address_line1": null,
                      "address_line2": null,
                      "city": null,
                      "state": null,
                      "postal_code": null,
                      "country": null,
                      "contact_name": null,
                      "contact_email": null,
                      "contact_phone": null,
                      "partner_office_ref": null,
                      "profile_source": null,
                      "profile_version": null,
                      "identity_review_status": null
                    },
                    {
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "name": "SBX",
                      "group_id": null,
                      "billing_npi": "9999999995",
                      "tin_type": "EI",
                      "taxonomy": "1223G0001X",
                      "control_prefix": "SBX",
                      "claim_office_code": null,
                      "claim_timezone": null,
                      "nea_facility_id": null,
                      "binding_kind": "sandbox",
                      "status": "ACTIVE",
                      "display_name": null,
                      "legal_name": null,
                      "address_line1": null,
                      "address_line2": null,
                      "city": null,
                      "state": null,
                      "postal_code": null,
                      "country": null,
                      "contact_name": null,
                      "contact_email": null,
                      "contact_phone": null,
                      "partner_office_ref": null,
                      "profile_source": null,
                      "profile_version": null,
                      "identity_review_status": null
                    },
                    {
                      "facility_id": "fac_qnwrs4rq9tjtqwv37phe",
                      "name": "SB2",
                      "group_id": null,
                      "billing_npi": "9999999995",
                      "tin_type": "EI",
                      "taxonomy": "1223G0001X",
                      "control_prefix": "SB2",
                      "claim_office_code": null,
                      "claim_timezone": null,
                      "nea_facility_id": null,
                      "binding_kind": "sandbox",
                      "status": "ACTIVE",
                      "display_name": null,
                      "legal_name": null,
                      "address_line1": null,
                      "address_line2": null,
                      "city": null,
                      "state": null,
                      "postal_code": null,
                      "country": null,
                      "contact_name": null,
                      "contact_email": null,
                      "contact_phone": null,
                      "partner_office_ref": null,
                      "profile_source": null,
                      "profile_version": null,
                      "identity_review_status": null
                    }
                  ]
                }
              }
            },
            "description": "The offices in scope",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List offices",
        "tags": [
          "facilities"
        ],
        "description": "List every office your credential reaches."
      },
      "post": {
        "description": "Register one facility. NPI is Luhn-checked, the control prefix is\nallocated inside the insert, and a duplicate (npi, tin) is a 409.",
        "operationId": "createFacility",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FacilityCreateBody"
              },
              "example": {
                "billingNpi": "9999900241",
                "tin": "990000024",
                "tinType": "EI",
                "taxonomy": "1223G0001X",
                "officeId": "your-office-17",
                "claimOfficeCode": "NORTH",
                "claimTimezone": "America/New_York"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "request_id": "evt_nxh76fn21ap0j5ans7at",
                  "facility_id": "fac_2b5g4kw42z7zqt0y8046",
                  "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                  "group_id": null,
                  "billing_npi": "9999900241",
                  "tin_type": "EI",
                  "control_prefix": "NEW",
                  "claim_office_code": "NORTH",
                  "claim_timezone": "America/New_York",
                  "binding_kind": "sandbox",
                  "status": "ACTIVE",
                  "display_name": "",
                  "legal_name": null,
                  "address_line1": "",
                  "address_line2": "",
                  "city": "",
                  "state": "",
                  "postal_code": "",
                  "country": "US",
                  "contact_name": "",
                  "contact_email": "",
                  "contact_phone": "",
                  "partner_office_ref": null,
                  "profile_source": "customer_supplied",
                  "profile_version": 1,
                  "capabilities": [
                    {
                      "capability": "claims",
                      "state": "UNCONFIGURED"
                    },
                    {
                      "capability": "attachments",
                      "state": "UNCONFIGURED"
                    },
                    {
                      "capability": "eligibility",
                      "state": "UNCONFIGURED"
                    },
                    {
                      "capability": "remittances",
                      "state": "UNCONFIGURED"
                    }
                  ]
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Create an office",
        "tags": [
          "facilities"
        ]
      }
    },
    "/v1/facilities/import": {
      "post": {
        "description": "Bulk facility registration. Each row is judged on its own so one\nbad row never sinks the file.",
        "operationId": "importFacilities",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FacilityImportBody"
              },
              "example": {
                "facilities": [
                  {
                    "billingNpi": "9999900258",
                    "tin": "990000025"
                  },
                  {
                    "billingNpi": "1234567890",
                    "tin": "990000778"
                  },
                  {
                    "billingNpi": "9999900258",
                    "tin": "990000025"
                  },
                  {
                    "billingNpi": "9999900266",
                    "tin": "990000026"
                  }
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "request_id": "evt_ynxr9rqjmte6a8cr2ch4",
                  "received": 4,
                  "created": 2,
                  "results": [
                    {
                      "index": 0,
                      "status": "created",
                      "facility_id": "fac_rk50recfer1p4h8rrb4w",
                      "control_prefix": "NEW"
                    },
                    {
                      "index": 1,
                      "status": "invalid",
                      "error": "billingNpi fails the 80840 Luhn check digit"
                    },
                    {
                      "index": 2,
                      "status": "duplicate"
                    },
                    {
                      "index": 3,
                      "status": "created",
                      "facility_id": "fac_2b3hhwz195xxnc9myfch",
                      "control_prefix": "NEW"
                    }
                  ]
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Import offices in bulk",
        "tags": [
          "facilities"
        ]
      }
    },
    "/v1/facilities/{facility_id}/capabilities": {
      "get": {
        "operationId": "getFacilityCapabilities",
        "parameters": [
          {
            "in": "path",
            "name": "facility_id",
            "required": true,
            "schema": {
              "title": "Facility Id",
              "type": "string"
            },
            "example": "fac_tycrfy0cs0qc7sq95eme"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {},
                "example": {
                  "request_id": "evt_4205ze8wkh0wgkrrzb72",
                  "capabilities": [
                    {
                      "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "capability": "attachments",
                      "state": "UNCONFIGURED",
                      "reason_code": null,
                      "evidence_reference": null,
                      "reviewed_by": null,
                      "reviewed_at": null,
                      "version": 1
                    },
                    {
                      "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "capability": "claims",
                      "state": "UNCONFIGURED",
                      "reason_code": null,
                      "evidence_reference": null,
                      "reviewed_by": null,
                      "reviewed_at": null,
                      "version": 1
                    },
                    {
                      "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "capability": "eligibility",
                      "state": "UNCONFIGURED",
                      "reason_code": null,
                      "evidence_reference": null,
                      "reviewed_by": null,
                      "reviewed_at": null,
                      "version": 1
                    },
                    {
                      "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "capability": "remittances",
                      "state": "UNCONFIGURED",
                      "reason_code": null,
                      "evidence_reference": null,
                      "reviewed_by": null,
                      "reviewed_at": null,
                      "version": 1
                    }
                  ]
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Get office capabilities",
        "tags": [
          "facilities"
        ],
        "description": "Read the readiness state of each Claim House service for one office."
      }
    },
    "/v1/facilities/{facility_id}/eligibility": {
      "get": {
        "operationId": "listFacilityEligibility",
        "parameters": [
          {
            "in": "path",
            "name": "facility_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Facility Id",
              "type": "string"
            },
            "example": "fac_q5s09nzww25ysd5a2f3g"
          },
          {
            "in": "query",
            "name": "since",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "format": "date-time",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Since"
            },
            "example": "2026-09-01T00:00:00Z"
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 100,
              "maximum": 500,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            },
            "example": 2
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilityListPage"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_ppc4dn32mh0yv310gtx6",
                  "facility_id": "fac_sandboxsandboxsand",
                  "results": [
                    {
                      "eligibility_id": "elg_cz2zee1eeh3tb79rxc58",
                      "facility_id": "fac_sandboxsandboxsand",
                      "payer_id": "94276",
                      "relationship": "self",
                      "service_date": "2026-09-07",
                      "status": "ACTIVE",
                      "outcome": "OK",
                      "error_class": null,
                      "vendor": "claimhouse",
                      "vendor_transaction_id": "test-smp_magic_active_full",
                      "vendor_latency_ms": 320,
                      "tenant_reference": "first-test-check",
                      "retrieved_at": "2026-09-07T15:00:00+00:00",
                      "rejection_summary": null,
                      "billing": {
                        "charged": false,
                        "state": "NOT_BILLABLE",
                        "reason": "test_mode",
                        "label": "Test mode",
                        "reason_label": "Test mode checks never reach a payer and are never charged",
                        "unit_price_micros": null
                      }
                    }
                  ]
                }
              }
            },
            "description": "The office's checks",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List an office's eligibility checks",
        "tags": [
          "eligibility"
        ],
        "description": "List recorded checks for one office, newest first, with ids, codes and outcomes only."
      }
    },
    "/v1/facilities/{facility_id}/go-live": {
      "get": {
        "description": "Where this office's go-live stands: sandbox, in review, live, or declined.",
        "operationId": "getGoLive",
        "parameters": [
          {
            "in": "path",
            "name": "facility_id",
            "required": true,
            "schema": {
              "pattern": "^fac_[a-z0-9]{20}$",
              "title": "Facility Id",
              "type": "string"
            },
            "example": "fac_tycrfy0cs0qc7sq95eme"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GoLiveResponse"
                },
                "example": {
                  "livemode": true,
                  "request_id": "evt_27epgwyqb17z10q384c1",
                  "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                  "state": "sandbox",
                  "reasons": [],
                  "submitted_at": null,
                  "decided_at": null,
                  "customer_message": null
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Get office go-live",
        "tags": [
          "facilities"
        ]
      },
      "post": {
        "description": "Take this office live for eligibility. A signed-in owner or admin\nonly. Needs a card on file (or an internal account). The office's NPI is checked against the national\nprovider registry: a match makes it live now (200); otherwise Claim\nHouse reviews it (202). Repeating while a review is open returns it.",
        "operationId": "startGoLive",
        "parameters": [
          {
            "in": "path",
            "name": "facility_id",
            "required": true,
            "schema": {
              "pattern": "^fac_[a-z0-9]{20}$",
              "title": "Facility Id",
              "type": "string"
            },
            "example": "fac_tycrfy0cs0qc7sq95eme"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GoLiveResponse"
                },
                "example": {
                  "livemode": true,
                  "request_id": "evt_bcyw9vfp513pzeywspyn",
                  "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                  "state": "live",
                  "reasons": [],
                  "submitted_at": null,
                  "decided_at": "2026-10-05T12:00:00+00:00",
                  "customer_message": null
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GoLiveResponse"
                },
                "example": {
                  "livemode": true,
                  "request_id": "evt_zpxydpm9hd7w98xca3bs",
                  "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                  "state": "in_review",
                  "reasons": [
                    "NAME_MISMATCH"
                  ],
                  "submitted_at": "2026-10-05T12:00:00+00:00",
                  "decided_at": null,
                  "customer_message": null
                }
              }
            },
            "description": "The office is in review",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Take an office live",
        "tags": [
          "facilities"
        ]
      }
    },
    "/v1/invitations": {
      "get": {
        "operationId": "listInvitations",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {},
                "example": {
                  "request_id": "evt_smqb8kmqf7gk589mq1ys",
                  "invitations": [
                    {
                      "invitation_id": "inv_c78sg2v0veqke88d7h7s",
                      "organization_name": "Sample Dental Group",
                      "intended_email": "sample.teammate@example.com",
                      "email": "sample.teammate@example.com",
                      "role": "submitter",
                      "office_scope": {
                        "kind": "SUBSET",
                        "facility_ids": [
                          "fac_tycrfy0cs0qc7sq95eme"
                        ]
                      },
                      "state": "PREPARED",
                      "version": 1,
                      "created_at": "2026-09-14T15:04:05+00:00"
                    }
                  ]
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List invitations",
        "tags": [
          "members"
        ],
        "description": "List every invitation your organization has prepared, newest first."
      },
      "post": {
        "operationId": "createInvitation",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InvitationPrepareBody"
              },
              "example": {
                "email": "sample.teammate@example.com",
                "role": "submitter",
                "scope_kind": "SUBSET",
                "office_ids": [
                  "fac_tycrfy0cs0qc7sq95eme"
                ],
                "actions": [
                  "claims.read",
                  "claims.submit",
                  "offices.read"
                ],
                "expires_at": "2026-09-21T15:04:05+00:00"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {},
                "example": {
                  "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                  "invitation_id": "inv_c78sg2v0veqke88d7h7s",
                  "intended_email_digest": "0000000000000000000000000000000000000000000000000000000000000000",
                  "intended_email_display": "sample.teammate@example.com",
                  "role_template": "submitter",
                  "proposed_scope_kind": "SUBSET",
                  "expires_at": "2026-09-21T15:04:05+00:00",
                  "clerk_invitation_id": null,
                  "delivery_operation_id": null,
                  "state": "PREPARED",
                  "version": 1,
                  "created_by": "user_EXAMPLE0000000000001",
                  "created_at": "2026-09-14T15:04:05+00:00",
                  "revoked_at": null,
                  "accepted_at": null,
                  "reconciled_at": null
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Prepare an invitation",
        "tags": [
          "members"
        ],
        "description": "Record a `PREPARED` invitation for a teammate without sending anything."
      }
    },
    "/v1/invitations/{invitation_id}/revoke": {
      "post": {
        "operationId": "revokeInvitation",
        "parameters": [
          {
            "in": "path",
            "name": "invitation_id",
            "required": true,
            "schema": {
              "title": "Invitation Id",
              "type": "string"
            },
            "example": "inv_c78sg2v0veqke88d7h7s"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReasonVersionBody"
              },
              "example": {
                "expected_version": 1,
                "reason": "Invited the wrong address."
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {},
                "example": {
                  "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                  "invitation_id": "inv_c78sg2v0veqke88d7h7s",
                  "intended_email_digest": "0000000000000000000000000000000000000000000000000000000000000000",
                  "intended_email_display": "sample.teammate@example.com",
                  "role_template": "submitter",
                  "proposed_scope_kind": "SUBSET",
                  "expires_at": "2026-09-21T15:04:05+00:00",
                  "clerk_invitation_id": null,
                  "delivery_operation_id": null,
                  "state": "REVOKED",
                  "version": 2,
                  "created_by": "user_EXAMPLE0000000000001",
                  "created_at": "2026-09-14T15:04:05+00:00",
                  "revoked_at": "2026-09-14T15:10:00+00:00",
                  "accepted_at": null,
                  "reconciled_at": null
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Revoke an invitation",
        "tags": [
          "members"
        ],
        "description": "Mark a `PREPARED` or `SENT` invitation as `REVOKED` so it cannot be used."
      }
    },
    "/v1/invitations/{invitation_id}/send": {
      "post": {
        "operationId": "sendInvitation",
        "parameters": [
          {
            "in": "path",
            "name": "invitation_id",
            "required": true,
            "schema": {
              "title": "Invitation Id",
              "type": "string"
            },
            "example": "inv_c78sg2v0veqke88d7h7s"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InvitationSendBody"
              },
              "example": {
                "expected_version": 1,
                "confirmed": true
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {},
                "example": {
                  "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                  "invitation_id": "inv_c78sg2v0veqke88d7h7s",
                  "intended_email_digest": "0000000000000000000000000000000000000000000000000000000000000000",
                  "intended_email_display": "sample.teammate@example.com",
                  "role_template": "submitter",
                  "proposed_scope_kind": "SUBSET",
                  "expires_at": "2026-09-21T15:04:05+00:00",
                  "clerk_invitation_id": "inv_s6kv7qsg8edf9b9me10y_EXAMPLE",
                  "delivery_operation_id": "op_fh92fzqy215mtxw02a6d",
                  "state": "SENT",
                  "version": 3,
                  "created_by": "user_EXAMPLE0000000000001",
                  "created_at": "2026-09-14T15:04:05+00:00",
                  "revoked_at": null,
                  "accepted_at": null,
                  "reconciled_at": null
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Send an invitation",
        "tags": [
          "members"
        ],
        "description": "Deliver a `PREPARED` invitation through the sign-in provider, once."
      }
    },
    "/v1/keys": {
      "get": {
        "description": "Every key this seller owns: metadata and grants, never a digest.",
        "operationId": "listKeys",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "request_id": "evt_6xsegfmnynpvgzbhgy1h",
                  "keys": [
                    {
                      "key_id": "key_6h9tywc98yqhsy5h7t0n",
                      "name": null,
                      "mode": "production",
                      "scope_kind": "seller",
                      "scope_ids": [
                        "sel_s4zf3w33k6x8j1e1z6sh"
                      ],
                      "permissions": [
                        "read",
                        "submit",
                        "webhooks"
                      ],
                      "created_by": "bootstrap",
                      "created_at": "2026-09-05T14:30:00+00:00",
                      "last_used_at": null,
                      "revoked_at": null,
                      "revoked_by": null
                    },
                    {
                      "key_id": "key_7jr01wnnggdpvnsy7a66",
                      "name": null,
                      "mode": "production",
                      "scope_kind": "facility",
                      "scope_ids": [
                        "fac_q5s09nzww25ysd5a2f3g"
                      ],
                      "permissions": [
                        "read",
                        "submit",
                        "webhooks"
                      ],
                      "created_by": "bootstrap",
                      "created_at": "2026-09-05T14:30:00+00:00",
                      "last_used_at": null,
                      "revoked_at": null,
                      "revoked_by": null
                    },
                    {
                      "key_id": "key_26z6a4mswbz9c34jjd9n",
                      "name": "docs verification",
                      "mode": "test",
                      "scope_kind": "seller",
                      "scope_ids": [
                        "sel_s4zf3w33k6x8j1e1z6sh"
                      ],
                      "permissions": [
                        "admin",
                        "read",
                        "submit",
                        "webhooks"
                      ],
                      "created_by": "bootstrap",
                      "created_at": "2026-09-05T14:30:00+00:00",
                      "last_used_at": null,
                      "revoked_at": null,
                      "revoked_by": null
                    },
                    {
                      "key_id": "key_rajhp4p69d3266hejjtc",
                      "name": null,
                      "mode": "production",
                      "scope_kind": "seller",
                      "scope_ids": [
                        "sel_s4zf3w33k6x8j1e1z6sh"
                      ],
                      "permissions": [
                        "admin",
                        "read",
                        "submit",
                        "webhooks"
                      ],
                      "created_by": "bootstrap",
                      "created_at": "2026-09-05T14:30:00+00:00",
                      "last_used_at": null,
                      "revoked_at": null,
                      "revoked_by": null
                    },
                    {
                      "key_id": "key_7v1bynctfrjr08xahty0",
                      "name": "docs verification",
                      "mode": "test",
                      "scope_kind": "facility",
                      "scope_ids": [
                        "fac_tycrfy0cs0qc7sq95eme"
                      ],
                      "permissions": [
                        "admin",
                        "read",
                        "submit",
                        "webhooks"
                      ],
                      "created_by": "bootstrap",
                      "created_at": "2026-09-05T14:30:00+00:00",
                      "last_used_at": null,
                      "revoked_at": null,
                      "revoked_by": null
                    },
                    {
                      "key_id": "key_98p1kx2vsy54ehpr2jnq",
                      "name": "docs verification",
                      "mode": "production",
                      "scope_kind": "seller",
                      "scope_ids": [
                        "sel_s4zf3w33k6x8j1e1z6sh"
                      ],
                      "permissions": [
                        "admin",
                        "read",
                        "submit",
                        "webhooks"
                      ],
                      "created_by": "bootstrap",
                      "created_at": "2026-09-05T14:30:00+00:00",
                      "last_used_at": null,
                      "revoked_at": null,
                      "revoked_by": null
                    },
                    {
                      "key_id": "key_yhzvgbk8v6w4xa9ywy57",
                      "name": "docs verification",
                      "mode": "test",
                      "scope_kind": "seller",
                      "scope_ids": [
                        "sel_s4zf3w33k6x8j1e1z6sh"
                      ],
                      "permissions": [
                        "read"
                      ],
                      "created_by": "bootstrap",
                      "created_at": "2026-09-05T14:30:00+00:00",
                      "last_used_at": null,
                      "revoked_at": null,
                      "revoked_by": null
                    }
                  ]
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List API keys",
        "tags": [
          "keys"
        ]
      },
      "post": {
        "description": "Mint one key inside this key's own scope. The secret is returned\nonce, here, and is never stored or shown again.",
        "operationId": "createKey",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateKeyBody"
              },
              "example": {
                "name": "north office submitter",
                "mode": "test",
                "scopeKind": "facility",
                "scopeIds": [
                  "fac_tycrfy0cs0qc7sq95eme"
                ],
                "permissions": [
                  "submit",
                  "read"
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "request_id": "evt_e3j4hjahy20pegkgy56s",
                  "key_id": "key_qh935chyky1z37jap1yj",
                  "name": "north office submitter",
                  "mode": "test",
                  "scope_kind": "facility",
                  "scope_ids": [
                    "fac_tycrfy0cs0qc7sq95eme"
                  ],
                  "permissions": [
                    "read",
                    "submit"
                  ],
                  "secret": "key_7qm2x9d4hs3ve6kt8wbn.EXAMPLEsecretEXAMPLEsecret",
                  "secret_shown_once": true
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Create an API key",
        "tags": [
          "keys"
        ]
      }
    },
    "/v1/keys/starter": {
      "post": {
        "description": "The organization's first test key, made on its first visit to the\nhome screen in test mode and shown there once (test mode spec 1.1).\n\nReturns ``created: false`` (and no secret) when the organization\nalready has, or has ever had, a test key. Test mode only; dashboard\nsessions only.",
        "operationId": "createStarterTestKey",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_81wbvwes6943xaszse1d",
                  "created": true,
                  "key_id": "key_7qm2x9d4hs3ve6kt8wbn",
                  "name": "Test key (created at signup)",
                  "mode": "test",
                  "scope_kind": "seller",
                  "scope_ids": [
                    "sel_s4zf3w33k6x8j1e1z6sh"
                  ],
                  "permissions": [
                    "read",
                    "submit",
                    "webhooks"
                  ],
                  "secret": "ch_test_key_7qm2x9d4hs3ve6kt8wbn.EXAMPLEsecretEXAMPLEsecret",
                  "secret_shown_once": true
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Create the starter test key",
        "tags": [
          "keys"
        ]
      }
    },
    "/v1/keys/{key_id}": {
      "delete": {
        "description": "Revoke one of this seller's keys. Immediate and not reversible.",
        "operationId": "revokeKey",
        "parameters": [
          {
            "in": "path",
            "name": "key_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Key Id",
              "type": "string"
            },
            "example": "key_1n71fpwn02kz0k3m5bbw"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "request_id": "evt_vc1amfhv11434kj9c446",
                  "key_id": "key_1n71fpwn02kz0k3m5bbw",
                  "revoked": true
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Revoke an API key",
        "tags": [
          "keys"
        ]
      }
    },
    "/v1/me": {
      "get": {
        "description": "Who this credential is: seller, mode, scope and reachable facilities.",
        "operationId": "getMe",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeResponse"
                },
                "example": {
                  "request_id": "evt_f8cwc9ew49wa6bjpqdyd",
                  "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                  "seller_name": "Sample Dental Group LLC",
                  "seller_status": "ACTIVE",
                  "principal": {
                    "kind": "api_key",
                    "key_id": "key_26z6a4mswbz9c34jjd9n"
                  },
                  "mode": "test",
                  "scope": {
                    "kind": "seller",
                    "ids": [
                      "sel_s4zf3w33k6x8j1e1z6sh"
                    ],
                    "permissions": [
                      "admin",
                      "read",
                      "submit",
                      "webhooks"
                    ]
                  },
                  "reachable_facility_ids": [
                    "fac_q5s09nzww25ysd5a2f3g",
                    "fac_w9qxypnbcw7b308jbbhh",
                    "fac_tycrfy0cs0qc7sq95eme",
                    "fac_qnwrs4rq9tjtqwv37phe",
                    "fac_2b5g4kw42z7zqt0y8046",
                    "fac_rk50recfer1p4h8rrb4w",
                    "fac_2b3hhwz195xxnc9myfch",
                    "fac_bkzth74mqx09wergap5c",
                    "fac_j0h554r1qy2nzrkvspb4"
                  ],
                  "reachable_facilities": [
                    {
                      "facility_id": "fac_q5s09nzww25ysd5a2f3g",
                      "name": "HAL",
                      "code": "HAL",
                      "city": null,
                      "state": null,
                      "mode": "production"
                    },
                    {
                      "facility_id": "fac_w9qxypnbcw7b308jbbhh",
                      "name": "HA2",
                      "code": "HA2",
                      "city": null,
                      "state": null,
                      "mode": "production"
                    },
                    {
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "name": "SBX",
                      "code": "SBX",
                      "city": null,
                      "state": null,
                      "mode": "sandbox"
                    },
                    {
                      "facility_id": "fac_qnwrs4rq9tjtqwv37phe",
                      "name": "SB2",
                      "code": "SB2",
                      "city": null,
                      "state": null,
                      "mode": "sandbox"
                    },
                    {
                      "facility_id": "fac_2b5g4kw42z7zqt0y8046",
                      "name": "MED",
                      "code": "MED",
                      "city": null,
                      "state": null,
                      "mode": "production"
                    },
                    {
                      "facility_id": "fac_rk50recfer1p4h8rrb4w",
                      "name": "TOD",
                      "code": "TOD",
                      "city": null,
                      "state": null,
                      "mode": "production"
                    },
                    {
                      "facility_id": "fac_2b3hhwz195xxnc9myfch",
                      "name": "TO2",
                      "code": "TO2",
                      "city": null,
                      "state": null,
                      "mode": "production"
                    },
                    {
                      "facility_id": "fac_bkzth74mqx09wergap5c",
                      "name": "ME2",
                      "code": "ME2",
                      "city": null,
                      "state": null,
                      "mode": "production"
                    },
                    {
                      "facility_id": "fac_j0h554r1qy2nzrkvspb4",
                      "name": "HA3",
                      "code": "HA3",
                      "city": null,
                      "state": null,
                      "mode": "production"
                    }
                  ],
                  "user": null,
                  "organization": null,
                  "role": null,
                  "permissions": [
                    "admin",
                    "read",
                    "submit",
                    "webhooks"
                  ],
                  "office_scope": null,
                  "authorization_version": null,
                  "capabilities": {},
                  "entitlements": [
                    {
                      "product": "eligibility",
                      "state": "ACTIVE",
                      "effective_from": "2026-09-05T14:30:00+00:00",
                      "effective_to": null
                    }
                  ]
                }
              }
            },
            "description": "Who is calling",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Get the current identity",
        "tags": [
          "auth"
        ]
      }
    },
    "/v1/members": {
      "get": {
        "operationId": "listMembers",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {},
                "example": {
                  "request_id": "evt_smqb8kmqf7gk589mq1ys",
                  "members": [
                    {
                      "membership_id": "mem_1w2pqxr89mss07rbry6s",
                      "name": "user_EXAMPLE0000000000001",
                      "email": "",
                      "role": "submitter",
                      "status": "ACTIVE",
                      "actions": [
                        "claims.read",
                        "claims.submit",
                        "offices.read"
                      ],
                      "scope_kind": "SUBSET",
                      "scope_ids": [
                        "fac_tycrfy0cs0qc7sq95eme"
                      ],
                      "scope_label": "1 offices",
                      "authorization_version": 3,
                      "last_sign_in_at": null
                    }
                  ]
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List members",
        "tags": [
          "members"
        ],
        "description": "List every person with a membership in your organization, with role, actions and office access."
      }
    },
    "/v1/members/{membership_id}": {
      "patch": {
        "operationId": "updateMember",
        "parameters": [
          {
            "in": "path",
            "name": "membership_id",
            "required": true,
            "schema": {
              "title": "Membership Id",
              "type": "string"
            },
            "example": "mem_1w2pqxr89mss07rbry6s"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MemberUpdateBody"
              },
              "example": {
                "expected_version": 3,
                "role": "viewer",
                "actions": [
                  "claims.read",
                  "offices.read"
                ],
                "scope_kind": "SUBSET",
                "office_ids": [
                  "fac_tycrfy0cs0qc7sq95eme"
                ],
                "reason": "Moved to front desk role."
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {},
                "example": {
                  "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                  "membership_id": "mem_1w2pqxr89mss07rbry6s",
                  "clerk_issuer": "https://issuer.EXAMPLE",
                  "clerk_user_id": "user_EXAMPLE0000000000001",
                  "clerk_org_id": "org_EXAMPLE0000000000001",
                  "role_template": "viewer",
                  "status": "ACTIVE",
                  "authorization_version": 4,
                  "all_current_and_future_offices": false,
                  "invitation_id": "inv_c78sg2v0veqke88d7h7s",
                  "source": "invitation",
                  "activated_at": "2026-09-14T15:04:05+00:00",
                  "suspended_at": null,
                  "revoked_at": null,
                  "last_reconciled_clerk_event": null,
                  "last_reconciled_at": null
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Update a member",
        "tags": [
          "members"
        ],
        "description": "Replace a member's role, actions and office access."
      }
    },
    "/v1/payer-mapping/mappings": {
      "get": {
        "operationId": "listMappings",
        "parameters": [
          {
            "in": "query",
            "name": "facility_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Facility Id"
            },
            "example": "fac_tycrfy0cs0qc7sq95eme"
          },
          {
            "in": "query",
            "name": "state",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 20,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "State"
            },
            "example": "NEEDS_CHOICE"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "request_id": "evt_1fzaj6804s7c90j3a0g3",
                  "mappings": [
                    {
                      "mapping_id": "map_ee5e7c07e4accbcb",
                      "scope": "organization",
                      "state": "CONFIRMED",
                      "reason": null,
                      "network_payer_id": "DELTO",
                      "payer_name": "Delta Dental of Ohio",
                      "usable_for_eligibility": true,
                      "needs_confirmation": false,
                      "resolved_by": null,
                      "confirmed_by": "user",
                      "confirmed_at": "2026-09-28T16:40:41.894269+00:00",
                      "candidates": [
                        {
                          "payer_id": "94276",
                          "name": "Delta Dental - DDIC",
                          "states": [],
                          "why": "similar words"
                        },
                        {
                          "payer_id": "DELTA",
                          "name": "Delta Dental of Michigan",
                          "states": [],
                          "why": "similar words"
                        },
                        {
                          "payer_id": "DELTO",
                          "name": "Delta Dental of Ohio",
                          "states": [],
                          "why": "similar words"
                        }
                      ]
                    },
                    {
                      "mapping_id": "map_4b19b5ec72e122ec",
                      "scope": "office",
                      "state": "CONFIRMED",
                      "reason": null,
                      "network_payer_id": "DELTO",
                      "payer_name": "Delta Dental of Ohio",
                      "usable_for_eligibility": true,
                      "needs_confirmation": false,
                      "resolved_by": null,
                      "confirmed_by": "user",
                      "confirmed_at": "2026-09-28T16:40:41.894269+00:00",
                      "candidates": [
                        {
                          "payer_id": "94276",
                          "name": "Delta Dental - DDIC",
                          "states": [],
                          "why": "similar words"
                        },
                        {
                          "payer_id": "DELTA",
                          "name": "Delta Dental of Michigan",
                          "states": [],
                          "why": "similar words"
                        },
                        {
                          "payer_id": "DELTO",
                          "name": "Delta Dental of Ohio",
                          "states": [],
                          "why": "similar words"
                        }
                      ]
                    },
                    {
                      "mapping_id": "map_a8ada2b1781d4323",
                      "scope": "office",
                      "state": "EXACT",
                      "reason": null,
                      "network_payer_id": "94276",
                      "payer_name": "Delta Dental - DDIC",
                      "usable_for_eligibility": true,
                      "needs_confirmation": false,
                      "resolved_by": "alternate_id",
                      "confirmed_by": null,
                      "confirmed_at": null,
                      "candidates": []
                    }
                  ]
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List insurance mappings",
        "tags": [
          "payers"
        ],
        "description": "List how the insurance names and payer ids your offices typed map to catalog payers, and which ones still need a person to pick."
      }
    },
    "/v1/payer-mapping/mappings/{mapping_id}/confirm": {
      "post": {
        "operationId": "confirmMapping",
        "parameters": [
          {
            "in": "path",
            "name": "mapping_id",
            "required": true,
            "schema": {
              "title": "Mapping Id",
              "type": "string"
            },
            "example": "map_4b19b5ec72e122ec"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ConfirmBody"
              },
              "example": {
                "network_payer_id": "DELTO"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "request_id": "evt_xxsf101bmd1qxbmysjgh",
                  "mapping": {
                    "mapping_id": "map_4b19b5ec72e122ec",
                    "scope": "office",
                    "state": "CONFIRMED",
                    "reason": null,
                    "network_payer_id": "DELTO",
                    "payer_name": "Delta Dental of Ohio",
                    "usable_for_eligibility": true,
                    "needs_confirmation": false,
                    "resolved_by": null,
                    "confirmed_by": "user",
                    "confirmed_at": "2026-09-28T16:40:41.894269+00:00",
                    "candidates": [
                      {
                        "payer_id": "94276",
                        "name": "Delta Dental - DDIC",
                        "states": [],
                        "why": "similar words"
                      },
                      {
                        "payer_id": "DELTA",
                        "name": "Delta Dental of Michigan",
                        "states": [],
                        "why": "similar words"
                      },
                      {
                        "payer_id": "DELTO",
                        "name": "Delta Dental of Ohio",
                        "states": [],
                        "why": "similar words"
                      }
                    ]
                  }
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Confirm an insurance mapping",
        "tags": [
          "payers"
        ],
        "description": "Pick or confirm the catalog payer for one mapping. It becomes `CONFIRMED` and is remembered for every office in your account."
      }
    },
    "/v1/payers": {
      "get": {
        "description": "The payer registry as Claim House JSON payer records. ``format=csv`` returns\nevery payer as one CSV document; JSON pages by ``pageToken``.",
        "operationId": "listPayers",
        "parameters": [
          {
            "in": "query",
            "name": "format",
            "required": false,
            "schema": {
              "default": "json",
              "enum": [
                "json",
                "csv"
              ],
              "title": "Format",
              "type": "string"
            },
            "example": "json"
          },
          {
            "in": "query",
            "name": "pageToken",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 200,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Pagetoken"
            }
          },
          {
            "in": "query",
            "name": "pageSize",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 50,
              "minimum": 10,
              "title": "Pagesize",
              "type": "integer"
            },
            "example": 10
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayerPage"
                },
                "example": {
                  "payers": [
                    {
                      "payerId": "pay_second",
                      "displayName": "Second Test Plan",
                      "primaryPayerId": "TESTPAYER2",
                      "aliases": [],
                      "names": [
                        "Second Test Plan"
                      ],
                      "transactionSupport": {
                        "eligibilityCheck": "NOT_SUPPORTED",
                        "claimStatus": "SUPPORTED",
                        "dentalClaimSubmission": "SUPPORTED",
                        "claimPayment": "NOT_SUPPORTED",
                        "unsolicitedClaimAttachment": "NOT_SUPPORTED"
                      },
                      "coverageTypes": [
                        "dental"
                      ],
                      "attachmentDoors": [],
                      "eraEnrollmentCode": null,
                      "paperEobShutoff": null,
                      "transaction_support": {
                        "eligibility": "NOT_SUPPORTED",
                        "claims": "COMING_SOON",
                        "claim_status": "COMING_SOON",
                        "remittance": "NOT_SUPPORTED",
                        "attachments": "NOT_SUPPORTED"
                      },
                      "enrollment_required": {
                        "eligibility": false,
                        "claims": false,
                        "claim_status": false,
                        "remittance": false,
                        "attachments": false
                      },
                      "states": [],
                      "accepted_searches": [
                        {
                          "search": "MEMBER_ID_NAME_DOB",
                          "source": "UNKNOWN",
                          "citation_url": null,
                          "note": null
                        }
                      ],
                      "stats": {
                        "eligibility_answered_rate_30d": null,
                        "eligibility_median_latency_ms_30d": null,
                        "checks_30d": null,
                        "minimum_sample": 20
                      }
                    },
                    {
                      "payerId": "pay_test",
                      "displayName": "Test Dental Plan",
                      "primaryPayerId": "TESTPAYER1",
                      "aliases": [
                        "TDP"
                      ],
                      "names": [
                        "Test Dental Plan",
                        "TDP of Testland"
                      ],
                      "transactionSupport": {
                        "eligibilityCheck": "SUPPORTED",
                        "claimStatus": "NOT_SUPPORTED",
                        "dentalClaimSubmission": "ENROLLMENT_REQUIRED",
                        "claimPayment": "ENROLLMENT_REQUIRED",
                        "unsolicitedClaimAttachment": "SUPPORTED"
                      },
                      "coverageTypes": [
                        "dental"
                      ],
                      "attachmentDoors": [
                        "network_A",
                        "portal"
                      ],
                      "eraEnrollmentCode": "S",
                      "paperEobShutoff": true,
                      "transaction_support": {
                        "eligibility": "NOT_SUPPORTED",
                        "claims": "COMING_SOON",
                        "claim_status": "NOT_SUPPORTED",
                        "remittance": "COMING_SOON",
                        "attachments": "COMING_SOON"
                      },
                      "enrollment_required": {
                        "eligibility": false,
                        "claims": true,
                        "claim_status": false,
                        "remittance": true,
                        "attachments": false
                      },
                      "states": [],
                      "accepted_searches": [
                        {
                          "search": "MEMBER_ID_NAME_DOB",
                          "source": "UNKNOWN",
                          "citation_url": null,
                          "note": null
                        }
                      ],
                      "stats": {
                        "eligibility_answered_rate_30d": null,
                        "eligibility_median_latency_ms_30d": null,
                        "checks_30d": null,
                        "minimum_sample": 20
                      }
                    }
                  ],
                  "nextPageToken": null
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List payers",
        "tags": [
          "payers"
        ]
      }
    },
    "/v1/payers/picker": {
      "get": {
        "operationId": "getPayerPicker",
        "parameters": [
          {
            "in": "query",
            "name": "facility_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Facility Id",
              "type": "string"
            },
            "example": "fac_tycrfy0cs0qc7sq95eme"
          },
          {
            "in": "query",
            "name": "purpose",
            "required": false,
            "schema": {
              "default": "eligibility",
              "pattern": "^(eligibility|claims)$",
              "title": "Purpose",
              "type": "string"
            }
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "request_id": "evt_c53wfdsgv124ncfd8szx",
                  "office_state": "GA",
                  "your_office": [
                    {
                      "label": "Delta Dental of Ohio",
                      "payer_id": "DELTO"
                    }
                  ],
                  "popular": [
                    {
                      "label": "Cigna",
                      "payer_id": "62308"
                    }
                  ],
                  "all": [
                    {
                      "kind": "family",
                      "family": "delta_dental",
                      "label": "Delta Dental",
                      "hint": "Delta Dental is separate companies by state. Pick the state on the member's card.",
                      "count": 3,
                      "items": [
                        {
                          "label": "Delta Dental of Georgia",
                          "payer_id": "94276",
                          "network_name": "Delta Dental - DDIC",
                          "states": [
                            "GA"
                          ],
                          "source": "claimhouse",
                          "via": "Delta Dental - DDIC"
                        },
                        {
                          "label": "Delta Dental of Michigan",
                          "payer_id": "DELTA",
                          "network_name": "Delta Dental of Michigan",
                          "states": [
                            "MI"
                          ],
                          "source": "network"
                        },
                        {
                          "label": "Delta Dental of Ohio",
                          "payer_id": "DELTO",
                          "network_name": "Delta Dental of Ohio",
                          "states": [
                            "OH"
                          ],
                          "source": "network"
                        }
                      ]
                    },
                    {
                      "kind": "payer",
                      "label": "GEHA",
                      "payer_id": "39026",
                      "network_name": "GEHA",
                      "states": [],
                      "source": "network"
                    }
                  ],
                  "payer_count": 5,
                  "row_count": 6
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Get the payer picker",
        "tags": [
          "payers"
        ],
        "description": "Get the browsable list of payers an office can check eligibility with: the office's own payers, popular payers, then A to Z with payer families grouped."
      }
    },
    "/v1/payers/resolve": {
      "get": {
        "operationId": "resolvePayer",
        "parameters": [
          {
            "in": "query",
            "name": "facility_id",
            "required": true,
            "schema": {
              "maxLength": 64,
              "minLength": 1,
              "title": "Facility Id",
              "type": "string"
            },
            "example": "fac_tycrfy0cs0qc7sq95eme"
          },
          {
            "in": "query",
            "name": "insurance",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 200,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Insurance"
            },
            "example": "Delta Dental of Georgia"
          },
          {
            "in": "query",
            "name": "payer_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 40,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Payer Id"
            },
            "example": "94276"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "request_id": "evt_gaf9ev7dbh24keyj7pwa",
                  "mapping": {
                    "mapping_id": "map_a8ada2b1781d4323",
                    "scope": "office",
                    "state": "EXACT",
                    "reason": null,
                    "network_payer_id": "94276",
                    "payer_name": "Delta Dental - DDIC",
                    "usable_for_eligibility": true,
                    "needs_confirmation": false,
                    "resolved_by": "alternate_id",
                    "confirmed_by": null,
                    "confirmed_at": null,
                    "candidates": []
                  }
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Match insurance to a payer",
        "tags": [
          "payers"
        ],
        "description": "Turn the insurance name or payer id an office typed into a stored mapping to a payer Claim House can check eligibility with."
      }
    },
    "/v1/payers/search": {
      "get": {
        "description": "Fuzzy lookup on name, primary id and alias. Rows use the Claim House JSON contract\npayer records plus the directory fields; the exact-match\nroute is ``/payers/{id}``. ``transaction`` keeps payers that take it through Claim\nHouse now; ``state`` keeps payers tied to that state and payers not tied to one.\nRanked by name match, then by Claim House usage.",
        "operationId": "searchPayers",
        "parameters": [
          {
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 120,
                  "minLength": 2,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Q"
            },
            "example": "cigna"
          },
          {
            "in": "query",
            "name": "transaction",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "eligibility",
                    "claims",
                    "claim_status",
                    "remittance",
                    "attachments"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Transaction"
            }
          },
          {
            "in": "query",
            "name": "state",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^[A-Za-z]{2}$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "State"
            },
            "example": "FL"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayerSearchResults"
                },
                "example": {
                  "request_id": "evt_cz8r87frpd2bba03a233",
                  "payers": [
                    {
                      "payerId": "pay_cigna",
                      "displayName": "Cigna Dental",
                      "primaryPayerId": "62308",
                      "aliases": [],
                      "names": [
                        "Cigna Dental"
                      ],
                      "transactionSupport": {
                        "eligibilityCheck": "SUPPORTED",
                        "claimStatus": "NOT_SUPPORTED",
                        "dentalClaimSubmission": "SUPPORTED",
                        "claimPayment": "ENROLLMENT_REQUIRED",
                        "unsolicitedClaimAttachment": "NOT_SUPPORTED"
                      },
                      "coverageTypes": [
                        "dental"
                      ],
                      "attachmentDoors": [],
                      "eraEnrollmentCode": "S",
                      "paperEobShutoff": null,
                      "transaction_support": {
                        "eligibility": "SUPPORTED",
                        "claims": "COMING_SOON",
                        "claim_status": "NOT_SUPPORTED",
                        "remittance": "COMING_SOON",
                        "attachments": "NOT_SUPPORTED"
                      },
                      "enrollment_required": {
                        "eligibility": false,
                        "claims": false,
                        "claim_status": false,
                        "remittance": true,
                        "attachments": false
                      },
                      "states": [],
                      "accepted_searches": [
                        {
                          "search": "MEMBER_ID_NAME_DOB",
                          "source": "PAYER_GUIDE",
                          "citation_url": "https://www.cigna.com/static/www-cigna-com/docs/5010-270-271-companion-guide.pdf",
                          "note": "First step of the payer's search order."
                        },
                        {
                          "search": "NAME_DOB_ONLY",
                          "source": "PAYER_GUIDE",
                          "citation_url": "https://www.cigna.com/static/www-cigna-com/docs/5010-270-271-companion-guide.pdf",
                          "note": "First name, last name and date of birth is the third step of the payer's search order."
                        },
                        {
                          "search": "MEMBER_ID_DOB",
                          "source": "PAYER_GUIDE",
                          "citation_url": "https://www.cigna.com/static/www-cigna-com/docs/5010-270-271-companion-guide.pdf",
                          "note": "Member ID with date of birth is the last step of the payer's search order."
                        }
                      ],
                      "stats": {
                        "eligibility_answered_rate_30d": 0.94,
                        "eligibility_median_latency_ms_30d": 1200,
                        "checks_30d": 30,
                        "minimum_sample": 20
                      }
                    }
                  ]
                }
              }
            },
            "description": "Matching payers",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Search payers",
        "tags": [
          "payers"
        ]
      }
    },
    "/v1/payers/{payer_id}/health": {
      "get": {
        "description": "How eligibility checks to this payer are going for Claim House as a\nwhole over the last hour and day: answered rate and payer-unavailable\nrate, rounded, null below the minimum sample. Counts only, across every\ncustomer; nothing about any one organization.",
        "operationId": "getPayerHealth",
        "parameters": [
          {
            "in": "path",
            "name": "payer_id",
            "required": true,
            "schema": {
              "maxLength": 80,
              "minLength": 1,
              "title": "Payer Id",
              "type": "string"
            },
            "example": "62308"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayerHealth"
                },
                "example": {
                  "request_id": "evt_s24w6n4khh2h51t01eag",
                  "payer_id": "62308",
                  "display_name": "Cigna Dental",
                  "transaction": "eligibility",
                  "eligibility": "SUPPORTED",
                  "measured": true,
                  "minimum_sample": 20,
                  "windows": {
                    "last_hour": {
                      "checks": 30,
                      "answered_rate": 0.94,
                      "payer_unavailable_rate": 0.06,
                      "median_latency_ms": 1200,
                      "sufficient_sample": true
                    },
                    "last_day": {
                      "checks": 30,
                      "answered_rate": 0.94,
                      "payer_unavailable_rate": 0.06,
                      "median_latency_ms": 1200,
                      "sufficient_sample": true
                    }
                  }
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Get a payer's health",
        "tags": [
          "payers"
        ]
      }
    },
    "/v1/settings/eligibility-summary": {
      "get": {
        "description": "Which blocks and CDT codes the summary view shows: the organization's\nsaved setting, the office's (with ``facility_id``), what a summary would\nuse now, and the defaults.",
        "operationId": "getEligibilitySummarySettings",
        "parameters": [
          {
            "in": "query",
            "name": "facility_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "minLength": 1,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Facility Id"
            },
            "example": "fac_EXAMPLE0000000000001"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilitySummarySettingsView"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_0ab99jh25h2b70hvryej",
                  "organization": null,
                  "effective": {
                    "blocks": [
                      "plan",
                      "totals",
                      "deductibles",
                      "maximums",
                      "out_of_pocket",
                      "coinsurance",
                      "procedures",
                      "frequencies",
                      "history",
                      "not_covered",
                      "missing_tooth",
                      "waiting_periods"
                    ],
                    "procedures": [
                      "D0120",
                      "D0140",
                      "D0150",
                      "D0210",
                      "D0220",
                      "D0272",
                      "D0274",
                      "D0330",
                      "D1110",
                      "D1120",
                      "D1206",
                      "D1208",
                      "D4341",
                      "D4342",
                      "D4910",
                      "D2740",
                      "D2750",
                      "D7140",
                      "D7210"
                    ],
                    "source": {
                      "blocks": "default",
                      "procedures": "default"
                    }
                  },
                  "defaults": {
                    "blocks": [
                      "plan",
                      "totals",
                      "deductibles",
                      "maximums",
                      "out_of_pocket",
                      "coinsurance",
                      "procedures",
                      "frequencies",
                      "history",
                      "not_covered",
                      "missing_tooth",
                      "waiting_periods"
                    ],
                    "procedures": [
                      "D0120",
                      "D0140",
                      "D0150",
                      "D0210",
                      "D0220",
                      "D0272",
                      "D0274",
                      "D0330",
                      "D1110",
                      "D1120",
                      "D1206",
                      "D1208",
                      "D4341",
                      "D4342",
                      "D4910",
                      "D2740",
                      "D2750",
                      "D7140",
                      "D7210"
                    ]
                  },
                  "blocks_available": [
                    "plan",
                    "totals",
                    "deductibles",
                    "maximums",
                    "out_of_pocket",
                    "coinsurance",
                    "procedures",
                    "frequencies",
                    "history",
                    "not_covered",
                    "missing_tooth",
                    "waiting_periods"
                  ]
                }
              }
            },
            "description": "The summary settings",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Read the summary settings",
        "tags": [
          "eligibility"
        ]
      },
      "put": {
        "description": "Save the summary's blocks and codes for the organization (an\norganization-wide key or session) or for one office (``facility_id``).\nThe call's ``fields=`` still wins over a saved setting.",
        "operationId": "putEligibilitySummarySettings",
        "parameters": [
          {
            "in": "query",
            "name": "facility_id",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "minLength": 1,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Facility Id"
            },
            "example": "fac_EXAMPLE0000000000001"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EligibilitySummarySettingsBody"
              },
              "example": {
                "blocks": [
                  "plan",
                  "totals",
                  "procedures",
                  "history"
                ],
                "procedures": [
                  "D0120",
                  "D1110",
                  "D2740"
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EligibilitySummarySettingsView"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_s7x4h51ye91j74m6tdd3",
                  "organization": null,
                  "facility_id": "fac_sandboxbatchsandbx",
                  "office": {
                    "scope": "office",
                    "facility_id": "fac_sandboxbatchsandbx",
                    "blocks": [
                      "plan",
                      "totals",
                      "procedures",
                      "history"
                    ],
                    "procedures": [
                      "D0120",
                      "D1110",
                      "D2740"
                    ],
                    "version": 1,
                    "updated_at": "2026-10-05T17:38:37.425394+00:00"
                  },
                  "effective": {
                    "blocks": [
                      "plan",
                      "totals",
                      "procedures",
                      "history"
                    ],
                    "procedures": [
                      "D0120",
                      "D1110",
                      "D2740"
                    ],
                    "source": {
                      "blocks": "office",
                      "procedures": "office"
                    }
                  },
                  "defaults": {
                    "blocks": [
                      "plan",
                      "totals",
                      "deductibles",
                      "maximums",
                      "out_of_pocket",
                      "coinsurance",
                      "procedures",
                      "frequencies",
                      "history",
                      "not_covered",
                      "missing_tooth",
                      "waiting_periods"
                    ],
                    "procedures": [
                      "D0120",
                      "D0140",
                      "D0150",
                      "D0210",
                      "D0220",
                      "D0272",
                      "D0274",
                      "D0330",
                      "D1110",
                      "D1120",
                      "D1206",
                      "D1208",
                      "D4341",
                      "D4342",
                      "D4910",
                      "D2740",
                      "D2750",
                      "D7140",
                      "D7210"
                    ]
                  },
                  "blocks_available": [
                    "plan",
                    "totals",
                    "deductibles",
                    "maximums",
                    "out_of_pocket",
                    "coinsurance",
                    "procedures",
                    "frequencies",
                    "history",
                    "not_covered",
                    "missing_tooth",
                    "waiting_periods"
                  ],
                  "saved": {
                    "scope": "office",
                    "facility_id": "fac_sandboxbatchsandbx",
                    "blocks": [
                      "plan",
                      "totals",
                      "procedures",
                      "history"
                    ],
                    "procedures": [
                      "D0120",
                      "D1110",
                      "D2740"
                    ],
                    "version": 1,
                    "updated_at": "2026-10-05T17:38:37.425394+00:00"
                  }
                }
              }
            },
            "description": "The settings after the save",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Save the summary settings",
        "tags": [
          "eligibility"
        ]
      }
    },
    "/v1/test/samples": {
      "get": {
        "description": "The sample dental patients test mode answers, labeled with the\noutcome each one produces. Synthetic; available in test mode only.",
        "operationId": "listTestSamples",
        "parameters": [
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "example": {
                  "livemode": false,
                  "request_id": "evt_q0wd9p8rgs4efe7evt1c",
                  "payers": [
                    {
                      "payer_id": "94276",
                      "name": "Delta Dental",
                      "patients": [
                        {
                          "sample_id": "smp_94276_full",
                          "scenario": "active_full",
                          "scenario_number": "E1",
                          "magic_member_id": "CH-ACTIVE-FULL",
                          "label": "Active, full benefits",
                          "outcome": "succeeds",
                          "outcome_tone": "success",
                          "claim_outcome": "paid_full",
                          "claim_outcome_label": "Paid in full",
                          "relationship": "self",
                          "subscriber": {
                            "first_name": "Avery",
                            "last_name": "Molar",
                            "member_id": "TEST9427601",
                            "date_of_birth": "1970-01-10"
                          },
                          "dependent": null
                        },
                        {
                          "sample_id": "smp_94276_dependent",
                          "scenario": "dependent_age_26",
                          "scenario_number": "E7",
                          "magic_member_id": "CH-DEP-AGE-26",
                          "label": "Dependent child, covered to 26",
                          "outcome": "succeeds",
                          "outcome_tone": "success",
                          "claim_outcome": "paid_full",
                          "claim_outcome_label": "Paid in full",
                          "relationship": "child",
                          "subscriber": {
                            "first_name": "Casey",
                            "last_name": "Bridge",
                            "member_id": "TEST9427605",
                            "date_of_birth": "1974-05-10"
                          },
                          "dependent": {
                            "first_name": "Mia",
                            "last_name": "Bridge",
                            "date_of_birth": "2014-03-05"
                          }
                        }
                      ]
                    }
                  ],
                  "scenarios": [
                    {
                      "member_id": "CH-ACTIVE-FULL",
                      "scenario": "active_full",
                      "scenario_number": "E1",
                      "label": "Active, full benefits",
                      "outcome": "succeeds",
                      "http_status": 200,
                      "error": null,
                      "result": "ACTIVE",
                      "catalog": true,
                      "aliases": [],
                      "note": ""
                    },
                    {
                      "member_id": "CH-AAA-71",
                      "scenario": "aaa_71",
                      "scenario_number": "E14",
                      "label": "Birth date mismatch (71)",
                      "outcome": "payer rejects",
                      "http_status": 422,
                      "error": "PAYER_REJECTED",
                      "result": null,
                      "catalog": true,
                      "aliases": [],
                      "note": ""
                    },
                    {
                      "member_id": "CH-RATE-LIMIT",
                      "scenario": "rate_limit",
                      "scenario_number": "",
                      "label": "Rate limited (429)",
                      "outcome": "429 at once; retry after the Retry-After seconds",
                      "http_status": 429,
                      "error": "TOO_MANY_REQUESTS",
                      "result": null,
                      "catalog": false,
                      "aliases": [],
                      "note": "Nothing is counted or written."
                    }
                  ]
                }
              }
            },
            "description": "Successful Response",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List test sample patients",
        "tags": [
          "test mode"
        ]
      }
    },
    "/v1/usage": {
      "get": {
        "description": "Meter counts over the ledger for one period. Read-model only.",
        "operationId": "getUsage",
        "parameters": [
          {
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "format": "date",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "From"
            },
            "example": "2026-09-01"
          },
          {
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "format": "date",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "To"
            },
            "example": "2026-09-30"
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageBody"
                },
                "example": {
                  "request_id": "evt_nkpjxkvjpdx58yvk4jgr",
                  "seller_id": "sel_s4zf3w33k6x8j1e1z6sh",
                  "period": {
                    "from": "2026-09-01",
                    "to": "2026-09-30"
                  },
                  "meters": {
                    "claims_submitted": 13,
                    "eligibility_checks": 0,
                    "attachment_packets": 0,
                    "facilities_active": 9
                  },
                  "by_facility": [
                    {
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "claims_submitted": 13
                    }
                  ],
                  "billing": {
                    "currency": "USD",
                    "billing_mode": "CARD",
                    "price_book": {
                      "price_book_id": "pbk_baseline_v1",
                      "name": "Baseline",
                      "version": 1,
                      "tier_method": "GRADUATED"
                    },
                    "products": [
                      {
                        "product": "eligibility_check",
                        "units": 260,
                        "pending_units": 1,
                        "free_units": 31,
                        "current_tier": 2,
                        "next_tier_at": 3501,
                        "next_unit_price_micros": 100000,
                        "amount_micros": 76500000,
                        "by_reason": [
                          {
                            "reason": "answered",
                            "state": "BILLABLE",
                            "units": 212,
                            "label": "Payer answered"
                          },
                          {
                            "reason": "payer_rejected_patient",
                            "state": "BILLABLE",
                            "units": 48,
                            "label": "Payer could not find the member"
                          },
                          {
                            "reason": "under_review",
                            "state": "PENDING",
                            "units": 1,
                            "label": "Under review"
                          },
                          {
                            "reason": "cache_hit",
                            "state": "NOT_BILLABLE",
                            "units": 20,
                            "label": "Saved answer"
                          },
                          {
                            "reason": "payer_unavailable",
                            "state": "NOT_BILLABLE",
                            "units": 11,
                            "label": "Payer was down"
                          }
                        ],
                        "tiers": [
                          {
                            "from_units": 1,
                            "to_units": 250,
                            "tier": 1,
                            "units": 250,
                            "unit_price_micros": 300000,
                            "amount_micros": 75000000
                          },
                          {
                            "from_units": 251,
                            "to_units": 3500,
                            "tier": 2,
                            "units": 10,
                            "unit_price_micros": 150000,
                            "amount_micros": 1500000
                          }
                        ]
                      }
                    ],
                    "minimum": {
                      "amount_micros": 500000000,
                      "covered_micros": 76500000,
                      "true_up_micros": 423500000,
                      "starts_on": "2026-09-01",
                      "full_monthly_micros": 500000000
                    },
                    "estimate": {
                      "subtotal_micros": 76500000,
                      "total_micros": 500000000
                    },
                    "offices": [
                      {
                        "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                        "group_id": null,
                        "units": {
                          "eligibility_check": 260
                        },
                        "free_units": {
                          "eligibility_check": 31
                        },
                        "amount_micros": 76500000
                      }
                    ],
                    "groups": [
                      {
                        "group_id": null,
                        "offices": 1,
                        "amount_micros": 76500000
                      }
                    ],
                    "statements": [
                      {
                        "statement_id": "stm_k3v9x2m7q4w8r1t6y5za",
                        "period": "2026-08-01",
                        "status": "FINAL",
                        "total_micros": 1000000000,
                        "billing_mode": "CARD",
                        "lines": [
                          {
                            "kind": "PRODUCT_TIER",
                            "product": "eligibility_check",
                            "tier": 1,
                            "from_units": 1,
                            "to_units": 250,
                            "units": 120,
                            "unit_price_micros": 300000,
                            "amount_micros": 36000000
                          },
                          {
                            "kind": "MINIMUM",
                            "product": null,
                            "tier": null,
                            "from_units": null,
                            "to_units": null,
                            "units": 1,
                            "unit_price_micros": 964000000,
                            "amount_micros": 964000000
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            },
            "description": "Usage for the period",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Get usage",
        "tags": [
          "usage"
        ]
      }
    },
    "/v1/usage/units": {
      "get": {
        "description": "Every unit billed in one month, newest first: whether it is charged and why.\n\n``period`` is the billing month (``YYYY-MM``, the current UTC month by\ndefault). Filters: ``product``, ``state``, ``reason`` (a public reason\ncode) and ``facilityId``. ``cursor`` is the ``next_cursor`` of the\nprevious page. Ids and codes only, never patient details: open a unit's\n``source_id`` to see the check under its own permissions. A caller\nlimited to some offices sees only those offices' units, and a caller\nsees only its own mode's units (a test key the test units).",
        "operationId": "listUsageUnits",
        "parameters": [
          {
            "in": "query",
            "name": "period",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^\\d{4}-(0[1-9]|1[0-2])$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Period"
            },
            "example": "2026-09"
          },
          {
            "in": "query",
            "name": "product",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(eligibility_check|claim_status_check|claim_submission|adjudicated_claim|attachment)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Product"
            }
          },
          {
            "in": "query",
            "name": "state",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "pattern": "^(BILLABLE|PENDING|NOT_BILLABLE)$",
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "State"
            }
          },
          {
            "in": "query",
            "name": "reason",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 48,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Reason"
            },
            "example": "payer_unavailable"
          },
          {
            "in": "query",
            "name": "facilityId",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 64,
                  "minLength": 1,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Facilityid"
            },
            "example": "fac_tycrfy0cs0qc7sq95eme"
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 40,
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Cursor"
            },
            "example": "18231"
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 100,
              "maximum": 500,
              "minimum": 1,
              "title": "Limit",
              "type": "integer"
            },
            "example": 100
          },
          {
            "description": "Pin the API version this request is served under. Leave it out for the current version (2026-11-01). A version Claim House does not serve is refused with 400 API_VERSION_UNKNOWN.",
            "in": "header",
            "name": "Claim-House-Version",
            "required": false,
            "schema": {
              "enum": [
                "2026-10-01",
                "2026-11-01"
              ],
              "example": "2026-11-01",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageUnitsPage"
                },
                "example": {
                  "request_id": "evt_nkpjxkvjpdx58yvk4jgr",
                  "period": "2026-09",
                  "data": [
                    {
                      "usage_id": 18232,
                      "occurred_at": "2026-09-20T15:04:11+00:00",
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "product": "eligibility_check",
                      "state": "BILLABLE",
                      "reason": "answered",
                      "label": "Payer answered",
                      "billing_period": "2026-09-01",
                      "source_id": "elg_wddgq19nhagdyseyyhte",
                      "channel": "api",
                      "actor": {
                        "kind": "api_key",
                        "id": "key_7qm2x9d4hs3ve6kt8wbn",
                        "name": "Front desk"
                      }
                    },
                    {
                      "usage_id": 18231,
                      "occurred_at": "2026-09-20T14:58:02+00:00",
                      "facility_id": "fac_tycrfy0cs0qc7sq95eme",
                      "product": "eligibility_check",
                      "state": "NOT_BILLABLE",
                      "reason": "payer_unavailable",
                      "label": "Payer was down",
                      "billing_period": "2026-09-01",
                      "source_id": "elg_r7c2m9x4k0v8t1q6p3b5",
                      "channel": "dashboard",
                      "actor": {
                        "kind": "member",
                        "id": "clerk:3f9a1c0d2b7e4a6f8c1d0e2a",
                        "name": null
                      }
                    }
                  ],
                  "next_cursor": null
                }
              }
            },
            "description": "Units, newest first",
            "headers": {
              "Claim-House-Version": {
                "description": "The API version this response was served under.",
                "schema": {
                  "example": "2026-11-01",
                  "type": "string"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List usage units",
        "tags": [
          "usage"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "BillingAccountResponse": {
        "description": "``GET /v1/billing``.",
        "properties": {
          "can_manage": {
            "description": "Whether this signed-in person may add or replace the card.",
            "title": "Can Manage",
            "type": "boolean"
          },
          "card": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/BillingCard"
              },
              {
                "type": "null"
              }
            ]
          },
          "card_setup_available": {
            "title": "Card Setup Available",
            "type": "boolean"
          },
          "live_billing_ok": {
            "description": "Whether billing lets this organization send live requests.",
            "title": "Live Billing Ok",
            "type": "boolean"
          },
          "mode": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "INTERNAL, CARD or INVOICE.",
            "title": "Mode"
          },
          "processor_mode": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "test or live once a card processor customer exists.",
            "title": "Processor Mode"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "state": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "CARD_REQUIRED, ACTIVE, PAST_DUE or SUSPENDED.",
            "title": "State"
          },
          "state_changed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "State Changed At"
          },
          "state_reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "State Reason"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "state",
          "mode",
          "processor_mode",
          "card",
          "state_reason",
          "state_changed_at",
          "live_billing_ok",
          "can_manage",
          "card_setup_available"
        ],
        "title": "BillingAccountResponse",
        "type": "object"
      },
      "BillingCard": {
        "properties": {
          "brand": {
            "title": "Brand",
            "type": "string"
          },
          "exp_month": {
            "title": "Exp Month",
            "type": "integer"
          },
          "exp_year": {
            "title": "Exp Year",
            "type": "integer"
          },
          "last4": {
            "title": "Last4",
            "type": "string"
          }
        },
        "required": [
          "brand",
          "last4",
          "exp_month",
          "exp_year"
        ],
        "title": "BillingCard",
        "type": "object"
      },
      "BillingRedirectResponse": {
        "properties": {
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "url": {
            "description": "The hosted card page to send the person to.",
            "title": "Url",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "url"
        ],
        "title": "BillingRedirectResponse",
        "type": "object"
      },
      "CardSessionBody": {
        "additionalProperties": false,
        "description": "``POST /v1/billing/card-session``: a fresh UUID from the dashboard per click.",
        "properties": {
          "nonce": {
            "description": "A UUID made by the dashboard for this click.",
            "maxLength": 36,
            "minLength": 36,
            "title": "Nonce",
            "type": "string"
          }
        },
        "required": [
          "nonce"
        ],
        "title": "CardSessionBody",
        "type": "object"
      },
      "ConfirmBody": {
        "properties": {
          "network_payer_id": {
            "maxLength": 40,
            "minLength": 1,
            "title": "Network Payer Id",
            "type": "string"
          }
        },
        "required": [
          "network_payer_id"
        ],
        "title": "ConfirmBody",
        "type": "object"
      },
      "CreateKeyBody": {
        "additionalProperties": false,
        "description": "`POST /v1/keys`. The caller may only mint a key inside its own scope,\npermissions and mode: the route enforces that containment.",
        "properties": {
          "mode": {
            "default": "test",
            "enum": [
              "test",
              "production"
            ],
            "title": "Mode",
            "type": "string"
          },
          "name": {
            "default": "",
            "maxLength": 120,
            "title": "Name",
            "type": "string"
          },
          "permissions": {
            "items": {
              "enum": [
                "submit",
                "read",
                "webhooks",
                "admin"
              ],
              "type": "string"
            },
            "minItems": 1,
            "title": "Permissions",
            "type": "array"
          },
          "scopeIds": {
            "items": {
              "type": "string"
            },
            "maxItems": 64,
            "title": "Scopeids",
            "type": "array"
          },
          "scopeKind": {
            "default": "seller",
            "enum": [
              "seller",
              "group",
              "facility"
            ],
            "title": "Scopekind",
            "type": "string"
          }
        },
        "required": [
          "permissions"
        ],
        "title": "CreateKeyBody",
        "type": "object"
      },
      "EligibilityAnswerOutcome": {
        "additionalProperties": true,
        "properties": {
          "answered": {
            "title": "Answered",
            "type": "boolean"
          },
          "payer_reason": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Payer Reason"
          },
          "reads_as": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reads As"
          }
        },
        "required": [
          "answered"
        ],
        "title": "EligibilityAnswerOutcome",
        "type": "object"
      },
      "EligibilityAnswerV3": {
        "additionalProperties": true,
        "description": "The organized answer, contract ``eligibility.v3``: every payer row exactly\nonce, as one line with one plain sentence, grouped by procedure code, by\nservice and into totals, with nothing computed, merged or dropped.\n\nRead top to bottom: who, plan, totals, by service, by procedure, history,\nnot covered, notes. ``verified`` is true only when every truth gate passed\nfor this exact answer; an answer that did not pass is withheld (the answer\nroute answers 409 ANSWER_NOT_VERIFIED, and the check answers with\n``verified: false`` and no organized block).",
        "properties": {
          "as_requested": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3AsRequested"
              },
              {
                "type": "null"
              }
            ]
          },
          "by_procedure": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Procedure"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "By Procedure"
          },
          "by_service": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Service"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "By Service"
          },
          "checked_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Checked At"
          },
          "contract": {
            "const": "eligibility.v3",
            "title": "Contract",
            "type": "string"
          },
          "counts": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Counts"
              },
              {
                "type": "null"
              }
            ]
          },
          "dependents": {
            "anyOf": [
              {
                "items": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Dependents"
          },
          "excluded": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Excluded"
          },
          "history": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3HistoryEntry"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "History"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "labels": {
            "anyOf": [
              {
                "additionalProperties": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "type": "object"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Plain words for the payer tokens in this answer.",
            "title": "Labels"
          },
          "lines": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Lines view only: every line once, each with its group (for example by_procedure/D1110).",
            "title": "Lines"
          },
          "links": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Links"
              },
              {
                "type": "null"
              }
            ]
          },
          "missing": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Sections an office usually expects that the payer did not send.",
            "title": "Missing"
          },
          "not_covered": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Not Covered"
          },
          "not_read": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Fields kept verbatim under a line's other, not organized.",
            "title": "Not Read"
          },
          "notes": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Notes"
          },
          "office": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Office"
              },
              {
                "type": "null"
              }
            ]
          },
          "other": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Other"
          },
          "patient": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "As returned by the payer.",
            "title": "Patient"
          },
          "payer": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Payer"
              },
              {
                "type": "null"
              }
            ]
          },
          "payer_answer": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "A check sent with view payer only: the payer's answer as received (transport metadata removed).",
            "title": "Payer Answer"
          },
          "plan": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Plan"
              },
              {
                "type": "null"
              }
            ]
          },
          "rejection": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rejection"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "status": {
            "enum": [
              "active",
              "inactive",
              "unknown",
              "not_answered"
            ],
            "title": "Status",
            "type": "string"
          },
          "subscriber": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "As returned by the payer.",
            "title": "Subscriber"
          },
          "summary": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Summary view only: the blocks and codes shown and where each choice came from.",
            "title": "Summary"
          },
          "totals": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Totals"
              },
              {
                "type": "null"
              }
            ]
          },
          "unverified_reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Only with verified false: why the organized answer is withheld. links.payer_answer still answers.",
            "title": "Unverified Reason"
          },
          "verified": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Verified"
          },
          "view": {
            "anyOf": [
              {
                "enum": [
                  "complete",
                  "summary",
                  "lines",
                  "payer"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The view served. Absent only on a check the payer did not answer (there is no answer to view).",
            "title": "View"
          }
        },
        "required": [
          "request_id",
          "id",
          "contract",
          "status"
        ],
        "title": "EligibilityAnswerV3",
        "type": "object"
      },
      "EligibilityBatchBody": {
        "description": "`POST /v1/eligibility/batches`: exactly one of ``patients``, ``rows`` or ``csv``.",
        "properties": {
          "csv": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "CSV text with a header row, at most 8 MB. The whole request body is at most 12 MB.",
            "title": "Csv"
          },
          "office": {
            "anyOf": [
              {
                "maxLength": 200,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The office (id, code or name) for every row or item that does not name its own.",
            "title": "Office"
          },
          "patients": {
            "anyOf": [
              {
                "items": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "1 to 10,000 checks, each exactly the flat POST /v1/eligibility body: office, insurance, member_id, patient {first_name, last_name, date_of_birth}, and optionally relationship (self, spouse, child or other), subscriber {first_name, last_name, date_of_birth} for spouse, child or other, group_number, visit_date, procedures, reference, max_age_seconds and view. Results name each item by its reference and its index.",
            "title": "Patients"
          },
          "preview": {
            "default": false,
            "description": "True: validate and resolve payers only; free, nothing stored.",
            "title": "Preview",
            "type": "boolean"
          },
          "reference": {
            "anyOf": [
              {
                "maxLength": 200,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reference"
          },
          "retry_payer_unavailable": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/RetryPayerUnavailable"
              },
              {
                "type": "null"
              }
            ],
            "description": "Optional. Without it every row is one check, and a payer-down row is final (and free)."
          },
          "rows": {
            "anyOf": [
              {
                "items": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "1 to 10,000 rows. Each row: reference, facility_id (the office id, office code or display name), payer, member_id, first_name, last_name, date_of_birth (YYYY-MM-DD, YYYYMMDD or MM/DD/YYYY), group_number, relationship (self, spouse, child or other; or 18, 01, 19, 34), patient {first_name, last_name, date_of_birth} unless relationship is self, and service_date (today, UTC, when blank). The same names as the CSV headers.",
            "title": "Rows"
          },
          "visit_date": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The visit date (YYYY-MM-DD, YYYYMMDD or MM/DD/YYYY) for every row or item that does not give its own; today (UTC) when neither does.",
            "title": "Visit Date"
          }
        },
        "title": "EligibilityBatchBody",
        "type": "object"
      },
      "EligibilityBatchCancelled": {
        "description": "`POST /v1/eligibility/batches/{batch_id}/cancel`: the summary after the cancel.",
        "properties": {
          "batch_id": {
            "title": "Batch Id",
            "type": "string"
          },
          "cancelled_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cancelled At"
          },
          "cancelled_rows": {
            "description": "How many waiting rows this call cancelled; 0 on a repeat call.",
            "title": "Cancelled Rows",
            "type": "integer"
          },
          "completed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "counts": {
            "additionalProperties": {
              "type": "integer"
            },
            "title": "Counts",
            "type": "object"
          },
          "created_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Created At"
          },
          "mode": {
            "title": "Mode",
            "type": "string"
          },
          "reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reference"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "retry_payer_unavailable": {
            "anyOf": [
              {
                "additionalProperties": {
                  "type": "integer"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Retry Payer Unavailable"
          },
          "state": {
            "description": "RUNNING while any row is PENDING or RUNNING; then CANCELLED for a cancelled batch, else COMPLETE",
            "title": "State",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "batch_id",
          "reference",
          "mode",
          "state",
          "created_at",
          "completed_at",
          "cancelled_at",
          "retry_payer_unavailable",
          "counts",
          "cancelled_rows"
        ],
        "title": "EligibilityBatchCancelled",
        "type": "object"
      },
      "EligibilityBatchCreated": {
        "properties": {
          "batch_id": {
            "title": "Batch Id",
            "type": "string"
          },
          "counts": {
            "additionalProperties": {
              "type": "integer"
            },
            "title": "Counts",
            "type": "object"
          },
          "idempotent_replay": {
            "title": "Idempotent Replay",
            "type": "boolean"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "state": {
            "title": "State",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "batch_id",
          "state",
          "idempotent_replay",
          "counts"
        ],
        "title": "EligibilityBatchCreated",
        "type": "object"
      },
      "EligibilityBatchDailyLimit": {
        "properties": {
          "limit": {
            "description": "Live checks this organization may make a day (UTC).",
            "title": "Limit",
            "type": "integer"
          },
          "remaining": {
            "title": "Remaining",
            "type": "integer"
          },
          "used_today": {
            "title": "Used Today",
            "type": "integer"
          }
        },
        "required": [
          "limit",
          "used_today",
          "remaining"
        ],
        "title": "EligibilityBatchDailyLimit",
        "type": "object"
      },
      "EligibilityBatchList": {
        "properties": {
          "batches": {
            "items": {
              "$ref": "#/components/schemas/EligibilityBatchSummary"
            },
            "title": "Batches",
            "type": "array"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "batches"
        ],
        "title": "EligibilityBatchList",
        "type": "object"
      },
      "EligibilityBatchPreview": {
        "properties": {
          "counts": {
            "additionalProperties": {
              "type": "integer"
            },
            "description": "rows, ready, refused, needs_payer, duplicate, over_daily_limit",
            "title": "Counts",
            "type": "object"
          },
          "daily_limit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityBatchDailyLimit"
              },
              {
                "type": "null"
              }
            ],
            "description": "Live mode only; null in test mode."
          },
          "ignored_columns": {
            "items": {
              "type": "string"
            },
            "title": "Ignored Columns",
            "type": "array"
          },
          "payer_choices": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Payer Choices",
            "type": "array"
          },
          "preview": {
            "title": "Preview",
            "type": "boolean"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "rows": {
            "items": {
              "$ref": "#/components/schemas/EligibilityBatchPreviewRow"
            },
            "title": "Rows",
            "type": "array"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "preview",
          "counts",
          "ignored_columns",
          "rows",
          "payer_choices"
        ],
        "title": "EligibilityBatchPreview",
        "type": "object"
      },
      "EligibilityBatchPreviewRow": {
        "properties": {
          "duplicate_of": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Duplicate Of"
          },
          "facility_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Facility Id"
          },
          "index": {
            "title": "Index",
            "type": "integer"
          },
          "over_daily_limit": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "description": "True when the row is ready but past today's remaining live limit: it will not be sent.",
            "title": "Over Daily Limit"
          },
          "payer": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Payer"
          },
          "problems": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityBatchProblem"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Problems"
          },
          "reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reference"
          },
          "state": {
            "description": "READY, REFUSED, NEEDS_PAYER or DUPLICATE",
            "title": "State",
            "type": "string"
          }
        },
        "required": [
          "index",
          "reference",
          "facility_id",
          "state"
        ],
        "title": "EligibilityBatchPreviewRow",
        "type": "object"
      },
      "EligibilityBatchProblem": {
        "properties": {
          "code": {
            "title": "Code",
            "type": "string"
          },
          "field": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Field"
          },
          "message": {
            "title": "Message",
            "type": "string"
          }
        },
        "required": [
          "field",
          "code",
          "message"
        ],
        "title": "EligibilityBatchProblem",
        "type": "object"
      },
      "EligibilityBatchResultRow": {
        "properties": {
          "attempts": {
            "description": "Checks this row has made (more than 1 only with retry_payer_unavailable).",
            "title": "Attempts",
            "type": "integer"
          },
          "billing": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Billing"
          },
          "duplicate_of": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Duplicate Of"
          },
          "eligibility_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Eligibility Id"
          },
          "error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error"
          },
          "facility_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Facility Id"
          },
          "http_status": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Http Status"
          },
          "idempotent_replay": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Idempotent Replay"
          },
          "index": {
            "title": "Index",
            "type": "integer"
          },
          "links": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityBatchRowLinks"
              },
              {
                "type": "null"
              }
            ],
            "description": "API version 2026-11-01 only, on a row the payer answered: where its answer (contract eligibility.v3) is read. Absent on other rows and under 2026-10-01."
          },
          "message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Message"
          },
          "next_try_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When a payer-down row is checked again; null otherwise.",
            "title": "Next Try At"
          },
          "payer": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Payer"
          },
          "problems": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityBatchProblem"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Problems"
          },
          "reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reference"
          },
          "rejection": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rejection"
          },
          "state": {
            "description": "PENDING, RUNNING, DONE, REFUSED, NEEDS_PAYER, DUPLICATE or CANCELLED",
            "title": "State",
            "type": "string"
          },
          "status": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Status"
          }
        },
        "required": [
          "index",
          "reference",
          "facility_id",
          "state",
          "http_status",
          "eligibility_id",
          "status",
          "error",
          "message",
          "idempotent_replay",
          "billing",
          "rejection",
          "problems",
          "payer",
          "duplicate_of",
          "attempts",
          "next_try_at"
        ],
        "title": "EligibilityBatchResultRow",
        "type": "object"
      },
      "EligibilityBatchRowLinks": {
        "properties": {
          "answer": {
            "description": "The complete answer: GET /v1/eligibility/{eligibility_id}/answer?contract=v3",
            "title": "Answer",
            "type": "string"
          },
          "summary": {
            "description": "The summary view of the same answer.",
            "title": "Summary",
            "type": "string"
          }
        },
        "required": [
          "answer",
          "summary"
        ],
        "title": "EligibilityBatchRowLinks",
        "type": "object"
      },
      "EligibilityBatchRowsPage": {
        "description": "`GET /v1/eligibility/batches/{batch_id}/rows`: one page, in row order.",
        "properties": {
          "batch_id": {
            "title": "Batch Id",
            "type": "string"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Pass as cursor for the next page; null at the end.",
            "title": "Next Cursor"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "rows": {
            "items": {
              "$ref": "#/components/schemas/EligibilityBatchResultRow"
            },
            "title": "Rows",
            "type": "array"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "batch_id",
          "rows",
          "next_cursor"
        ],
        "title": "EligibilityBatchRowsPage",
        "type": "object"
      },
      "EligibilityBatchSummary": {
        "properties": {
          "batch_id": {
            "title": "Batch Id",
            "type": "string"
          },
          "cancelled_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cancelled At"
          },
          "completed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "counts": {
            "additionalProperties": {
              "type": "integer"
            },
            "title": "Counts",
            "type": "object"
          },
          "created_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Created At"
          },
          "reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reference"
          },
          "retry_payer_unavailable": {
            "anyOf": [
              {
                "additionalProperties": {
                  "type": "integer"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Retry Payer Unavailable"
          },
          "state": {
            "title": "State",
            "type": "string"
          }
        },
        "required": [
          "batch_id",
          "reference",
          "state",
          "created_at",
          "completed_at",
          "counts"
        ],
        "title": "EligibilityBatchSummary",
        "type": "object"
      },
      "EligibilityBatchView": {
        "description": "`GET /v1/eligibility/batches/{batch_id}`: the summary and counts, no rows.",
        "properties": {
          "batch_id": {
            "title": "Batch Id",
            "type": "string"
          },
          "cancelled_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cancelled At"
          },
          "completed_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "counts": {
            "additionalProperties": {
              "type": "integer"
            },
            "title": "Counts",
            "type": "object"
          },
          "created_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Created At"
          },
          "mode": {
            "title": "Mode",
            "type": "string"
          },
          "reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reference"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "retry_payer_unavailable": {
            "anyOf": [
              {
                "additionalProperties": {
                  "type": "integer"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Retry Payer Unavailable"
          },
          "state": {
            "description": "RUNNING while any row is PENDING or RUNNING; then CANCELLED for a cancelled batch, else COMPLETE",
            "title": "State",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "batch_id",
          "reference",
          "mode",
          "state",
          "created_at",
          "completed_at",
          "cancelled_at",
          "retry_payer_unavailable",
          "counts"
        ],
        "title": "EligibilityBatchView",
        "type": "object"
      },
      "EligibilityBilling": {
        "description": "Whether this check is charged and why, from its usage unit.",
        "properties": {
          "charged": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "description": "true when charged, false when free, null while the unit is under review (PENDING).",
            "title": "Charged"
          },
          "label": {
            "description": "A short plain label for the reason, for example \"Payer was down\".",
            "title": "Label",
            "type": "string"
          },
          "reason": {
            "description": "Why, as a stable code: answered, payer_rejected_patient, payer_unavailable, cache_hit, test_mode, under_review and the others listed in the pricing guide.",
            "title": "Reason",
            "type": "string"
          },
          "reason_label": {
            "description": "One plain sentence that says whether and why it is charged.",
            "title": "Reason Label",
            "type": "string"
          },
          "state": {
            "enum": [
              "BILLABLE",
              "PENDING",
              "NOT_BILLABLE"
            ],
            "title": "State",
            "type": "string"
          },
          "unit_price_micros": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "On a single check that is charged: the price this unit is rated at in its month so far, in micros (1 USD = 1,000,000). An estimate until the monthly statement is final. Null in lists and when not charged.",
            "title": "Unit Price Micros"
          }
        },
        "required": [
          "charged",
          "state",
          "reason",
          "label",
          "reason_label"
        ],
        "title": "EligibilityBilling",
        "type": "object"
      },
      "EligibilityBody": {
        "description": "`POST /v1/eligibility` (spec 2.1).",
        "properties": {
          "facility_id": {
            "description": "The office id, or its office code or exact office name.",
            "maxLength": 120,
            "minLength": 1,
            "title": "Facility Id",
            "type": "string"
          },
          "max_age_seconds": {
            "anyOf": [
              {
                "maximum": 604800.0,
                "minimum": 0.0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Reuse a stored answer at most this old; 0 always asks the payer.",
            "title": "Max Age Seconds"
          },
          "mode": {
            "anyOf": [
              {
                "enum": [
                  "standard",
                  "enhanced",
                  "auto"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Detail level: standard is the payer's eligibility answer; enhanced adds plan and procedure-level detail for payers that support it; auto picks enhanced when the payer supports it, else standard. Default standard.",
            "title": "Mode"
          },
          "patient": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityPersonBody"
              },
              {
                "type": "null"
              }
            ],
            "description": "The dependent, when the patient is not the subscriber."
          },
          "payer": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityPayer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Whatever you know about the payer; may replace or accompany payer_id."
          },
          "payer_id": {
            "anyOf": [
              {
                "maxLength": 120,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Payer Id"
          },
          "procedure_codes": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "maxItems": 10,
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "CDT codes for benefit detail, at most ten.",
            "title": "Procedure Codes"
          },
          "service_date": {
            "anyOf": [
              {
                "format": "date",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Defaults to today (UTC).",
            "title": "Service Date"
          },
          "subscriber": {
            "$ref": "#/components/schemas/EligibilityPersonBody"
          },
          "tenant_reference": {
            "anyOf": [
              {
                "maxLength": 200,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Tenant Reference"
          }
        },
        "required": [
          "facility_id",
          "subscriber"
        ],
        "title": "EligibilityBody",
        "type": "object"
      },
      "EligibilityCache": {
        "additionalProperties": true,
        "description": "Whether this answer was asked of the payer now or reused.",
        "properties": {
          "age_seconds": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "How old the answer is, in seconds.",
            "title": "Age Seconds"
          },
          "state": {
            "description": "fresh when the payer was asked for this check; hit when a stored answer was reused.",
            "title": "State",
            "type": "string"
          }
        },
        "required": [
          "state"
        ],
        "title": "EligibilityCache",
        "type": "object"
      },
      "EligibilityCheckFacts": {
        "additionalProperties": true,
        "description": "What the check call itself did (API version 2026-11-01).",
        "properties": {
          "corrections": {
            "anyOf": [
              {
                "items": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Every normalization applied to the request (dates, codes, the office); absent when none.",
            "title": "Corrections"
          },
          "idempotency_key": {
            "description": "The key the check ran under: yours, or the one derived for a flat request sent without one.",
            "title": "Idempotency Key",
            "type": "string"
          },
          "idempotency_key_source": {
            "enum": [
              "header",
              "derived",
              "fresh"
            ],
            "title": "Idempotency Key Source",
            "type": "string"
          },
          "payer_resolution": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "How the payer was matched.",
            "title": "Payer Resolution"
          },
          "reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Your reference, when you sent one.",
            "title": "Reference"
          },
          "replayed": {
            "description": "True when this replays the recorded result of the same request.",
            "title": "Replayed",
            "type": "boolean"
          },
          "reused": {
            "description": "True when a stored answer was reused (free).",
            "title": "Reused",
            "type": "boolean"
          },
          "view": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The view the flat request asked for, when it sent one.",
            "title": "View"
          }
        },
        "required": [
          "idempotency_key",
          "idempotency_key_source",
          "replayed",
          "reused"
        ],
        "title": "EligibilityCheckFacts",
        "type": "object"
      },
      "EligibilityCheckPdf": {
        "additionalProperties": true,
        "properties": {
          "artifact_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Artifact Id"
          },
          "error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error"
          },
          "filename": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Filename"
          },
          "kind": {
            "anyOf": [
              {
                "const": "complete",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The complete PDF, when ready.",
            "title": "Kind"
          },
          "status": {
            "enum": [
              "ready",
              "unavailable"
            ],
            "title": "Status",
            "type": "string"
          }
        },
        "required": [
          "status"
        ],
        "title": "EligibilityCheckPdf",
        "type": "object"
      },
      "EligibilityCheckRequest": {
        "additionalProperties": false,
        "description": "`POST /v1/eligibility` in camelCase partner JSON. ``facilityId`` is a\nClaim House addition and is required; it also takes the office code or\nthe exact office name. The payer is ``tradingPartnerServiceId``\nor the ``payer`` object, or both when they agree. The legacy\nsnake_case body stays accepted on the same route.",
        "properties": {
          "dependents": {
            "items": {
              "$ref": "#/components/schemas/EligibilityDependent"
            },
            "maxItems": 1,
            "title": "Dependents",
            "type": "array"
          },
          "encounter": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityEncounter"
              },
              {
                "type": "null"
              }
            ]
          },
          "facilityId": {
            "maxLength": 120,
            "minLength": 1,
            "title": "Facilityid",
            "type": "string"
          },
          "max_age_seconds": {
            "anyOf": [
              {
                "maximum": 604800.0,
                "minimum": 0.0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Max Age Seconds"
          },
          "payer": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityPayer"
              },
              {
                "type": "null"
              }
            ]
          },
          "provider": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityProvider"
              },
              {
                "type": "null"
              }
            ]
          },
          "subscriber": {
            "$ref": "#/components/schemas/EligibilitySubscriber"
          },
          "tenantReference": {
            "anyOf": [
              {
                "maxLength": 200,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Tenantreference"
          },
          "tradingPartnerServiceId": {
            "anyOf": [
              {
                "pattern": "^[A-Za-z0-9.\\-_ ]{1,80}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Tradingpartnerserviceid"
          }
        },
        "required": [
          "facilityId",
          "subscriber"
        ],
        "title": "EligibilityCheckRequest",
        "type": "object"
      },
      "EligibilityCheckResponse": {
        "additionalProperties": true,
        "description": "``POST /v1/eligibility``: one eligibility check.",
        "properties": {
          "artifact_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The PDF's artifact id with include=pdf; else null.",
            "title": "Artifact Id"
          },
          "billing": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityBilling"
              },
              {
                "type": "null"
              }
            ],
            "description": "Null only for a check recorded before usage metering began."
          },
          "cache": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityCache"
              },
              {
                "type": "null"
              }
            ]
          },
          "eligibility_id": {
            "title": "Eligibility Id",
            "type": "string"
          },
          "facility_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Facility Id"
          },
          "idempotent_replay": {
            "description": "True when this replays the recorded result of an earlier request with the same Idempotency-Key (the Idempotent-Replayed header says the same).",
            "title": "Idempotent Replay",
            "type": "boolean"
          },
          "mode": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The detail level: standard or enhanced.",
            "title": "Mode"
          },
          "operation_id": {
            "description": "This request's operation. It can differ from eligibility_id when an earlier answer is reused.",
            "title": "Operation Id",
            "type": "string"
          },
          "payer_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Payer Id"
          },
          "payer_resolution": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/PayerResolution"
              },
              {
                "type": "null"
              }
            ],
            "description": "How the payer was matched."
          },
          "pdf_error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "With include=pdf only, when the PDF is unavailable.",
            "title": "Pdf Error"
          },
          "pdf_filename": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The PDF's file name with include=pdf; else null.",
            "title": "Pdf Filename"
          },
          "pdf_status": {
            "anyOf": [
              {
                "enum": [
                  "ready",
                  "unavailable"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "With include=pdf only: ready, or unavailable with pdf_error.",
            "title": "Pdf Status"
          },
          "procedure_codes": {
            "items": {
              "type": "string"
            },
            "title": "Procedure Codes",
            "type": "array"
          },
          "request_corrections": {
            "description": "Every normalization applied to the request; empty when none.",
            "items": {
              "$ref": "#/components/schemas/RequestCorrection"
            },
            "title": "Request Corrections",
            "type": "array"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "request_reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Customer reference retained for this intent, distinct from the reused answer's tenant_reference. Null on legacy cache intents without saved context.",
            "title": "Request Reference"
          },
          "retrieved_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the payer answered.",
            "title": "Retrieved At"
          },
          "reused": {
            "description": "True when a stored answer was reused (free): eligibility_id and retrieved_at are the original check's. max_age_seconds controls reuse.",
            "title": "Reused",
            "type": "boolean"
          },
          "service_date": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Service Date"
          },
          "status": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Status"
          },
          "tenant_reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Tenant Reference"
          }
        },
        "required": [
          "request_id",
          "eligibility_id",
          "billing",
          "operation_id",
          "request_reference",
          "idempotent_replay",
          "reused",
          "payer_resolution",
          "request_corrections",
          "artifact_id",
          "pdf_filename"
        ],
        "title": "EligibilityCheckResponse",
        "type": "object"
      },
      "EligibilityCheckResponseV3": {
        "additionalProperties": true,
        "description": "``POST /v1/eligibility`` under API version 2026-11-01: the answer the\ncheck made (``complete`` unless the flat request asked for another view),\nthen ``billing``, ``request`` and ``idempotent_replay``; ``pdf`` with\n``include=pdf``.",
        "properties": {
          "as_requested": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3AsRequested"
              },
              {
                "type": "null"
              }
            ]
          },
          "billing": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Whether this check is charged and why. Absent only when the billing line could not be read.",
            "title": "Billing"
          },
          "by_procedure": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Procedure"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "By Procedure"
          },
          "by_service": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Service"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "By Service"
          },
          "checked_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Checked At"
          },
          "contract": {
            "const": "eligibility.v3",
            "title": "Contract",
            "type": "string"
          },
          "counts": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Counts"
              },
              {
                "type": "null"
              }
            ]
          },
          "dependents": {
            "anyOf": [
              {
                "items": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Dependents"
          },
          "excluded": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Excluded"
          },
          "history": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3HistoryEntry"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "History"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "idempotent_replay": {
            "title": "Idempotent Replay",
            "type": "boolean"
          },
          "labels": {
            "anyOf": [
              {
                "additionalProperties": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "type": "object"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Plain words for the payer tokens in this answer.",
            "title": "Labels"
          },
          "lines": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Lines view only: every line once, each with its group (for example by_procedure/D1110).",
            "title": "Lines"
          },
          "links": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Links"
              },
              {
                "type": "null"
              }
            ]
          },
          "missing": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Sections an office usually expects that the payer did not send.",
            "title": "Missing"
          },
          "not_covered": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Not Covered"
          },
          "not_read": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Fields kept verbatim under a line's other, not organized.",
            "title": "Not Read"
          },
          "notes": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Notes"
          },
          "office": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Office"
              },
              {
                "type": "null"
              }
            ]
          },
          "other": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Other"
          },
          "patient": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "As returned by the payer.",
            "title": "Patient"
          },
          "payer": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Payer"
              },
              {
                "type": "null"
              }
            ]
          },
          "payer_answer": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "A check sent with view payer only: the payer's answer as received (transport metadata removed).",
            "title": "Payer Answer"
          },
          "pdf": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityCheckPdf"
              },
              {
                "type": "null"
              }
            ]
          },
          "plan": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Plan"
              },
              {
                "type": "null"
              }
            ]
          },
          "rejection": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rejection"
          },
          "request": {
            "$ref": "#/components/schemas/EligibilityCheckFacts"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "status": {
            "enum": [
              "active",
              "inactive",
              "unknown",
              "not_answered"
            ],
            "title": "Status",
            "type": "string"
          },
          "subscriber": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "As returned by the payer.",
            "title": "Subscriber"
          },
          "summary": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Summary view only: the blocks and codes shown and where each choice came from.",
            "title": "Summary"
          },
          "totals": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Totals"
              },
              {
                "type": "null"
              }
            ]
          },
          "unverified_reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Only with verified false: why the organized answer is withheld. links.payer_answer still answers.",
            "title": "Unverified Reason"
          },
          "verified": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Verified"
          },
          "view": {
            "anyOf": [
              {
                "enum": [
                  "complete",
                  "summary",
                  "lines",
                  "payer"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The view served. Absent only on a check the payer did not answer (there is no answer to view).",
            "title": "View"
          }
        },
        "required": [
          "request_id",
          "id",
          "contract",
          "status",
          "request",
          "idempotent_replay"
        ],
        "title": "EligibilityCheckResponseV3",
        "type": "object"
      },
      "EligibilityDependent": {
        "additionalProperties": false,
        "description": "The patient when not the subscriber: names and date of birth required.",
        "properties": {
          "dateOfBirth": {
            "title": "Dateofbirth",
            "type": "string"
          },
          "firstName": {
            "maxLength": 35,
            "minLength": 1,
            "title": "Firstname",
            "type": "string"
          },
          "groupNumber": {
            "anyOf": [
              {
                "maxLength": 50,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Groupnumber"
          },
          "lastName": {
            "maxLength": 60,
            "minLength": 1,
            "title": "Lastname",
            "type": "string"
          },
          "memberId": {
            "anyOf": [
              {
                "maxLength": 80,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Memberid"
          },
          "relationshipToSubscriberCode": {
            "anyOf": [
              {
                "maxLength": 10,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Relationshiptosubscribercode"
          }
        },
        "required": [
          "firstName",
          "lastName",
          "dateOfBirth"
        ],
        "title": "EligibilityDependent",
        "type": "object"
      },
      "EligibilityEncounter": {
        "additionalProperties": false,
        "properties": {
          "dateOfService": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Dateofservice"
          },
          "procedureCode": {
            "anyOf": [
              {
                "pattern": "^D\\d{4}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Procedurecode"
          },
          "procedureCodes": {
            "items": {
              "type": "string"
            },
            "maxItems": 10,
            "title": "Procedurecodes",
            "type": "array"
          },
          "serviceTypeCodes": {
            "items": {
              "type": "string"
            },
            "maxItems": 10,
            "title": "Servicetypecodes",
            "type": "array"
          }
        },
        "title": "EligibilityEncounter",
        "type": "object"
      },
      "EligibilityFlatPatient": {
        "additionalProperties": false,
        "description": "The person being seen. PHI: never logged, never echoed.",
        "properties": {
          "date_of_birth": {
            "description": "YYYY-MM-DD, YYYYMMDD or MM/DD/YYYY.",
            "format": "date",
            "title": "Date Of Birth",
            "type": "string"
          },
          "first_name": {
            "maxLength": 35,
            "minLength": 1,
            "title": "First Name",
            "type": "string"
          },
          "last_name": {
            "maxLength": 60,
            "minLength": 1,
            "title": "Last Name",
            "type": "string"
          }
        },
        "required": [
          "first_name",
          "last_name",
          "date_of_birth"
        ],
        "title": "EligibilityFlatPatient",
        "type": "object"
      },
      "EligibilityFlatRequest": {
        "additionalProperties": false,
        "description": "`POST /v1/eligibility`, the flat request (SPEC R5).\n\nThe patient is the person being seen. Without ``relationship`` the\npatient is the policy holder; with ``relationship`` (``spouse``,\n``child`` or ``other``) send the policy holder as ``subscriber``. The\nmember ID is the policy holder's. The Idempotency-Key header is optional\non this shape: without one, the key is derived from the check and the\nUTC day and returned as ``request.idempotency_key``.",
        "properties": {
          "group_number": {
            "anyOf": [
              {
                "maxLength": 50,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Group Number"
          },
          "insurance": {
            "description": "A payer id, the practice system's payer id, or the insurance name as the office records it.",
            "maxLength": 120,
            "minLength": 1,
            "pattern": "^[^\\x00-\\x1f]+$",
            "title": "Insurance",
            "type": "string"
          },
          "max_age_seconds": {
            "anyOf": [
              {
                "maximum": 604800.0,
                "minimum": 0.0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Reuse a stored answer at most this old; 0 always asks the payer.",
            "title": "Max Age Seconds"
          },
          "member_id": {
            "description": "The policy holder's member ID.",
            "maxLength": 80,
            "minLength": 1,
            "title": "Member Id",
            "type": "string"
          },
          "office": {
            "anyOf": [
              {
                "maxLength": 120,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The office id, office code or exact office name. Optional when the key reaches one office.",
            "title": "Office"
          },
          "patient": {
            "$ref": "#/components/schemas/EligibilityFlatPatient"
          },
          "procedures": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "maxItems": 10,
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "CDT codes, at most ten.",
            "title": "Procedures"
          },
          "reference": {
            "anyOf": [
              {
                "maxLength": 200,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Your own reference, echoed back.",
            "title": "Reference"
          },
          "relationship": {
            "anyOf": [
              {
                "maxLength": 10,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The patient's relationship to the policy holder: self (the default), spouse, child or other; also the X12 code (18, 01, 19, other dependent codes) and any letter case.",
            "title": "Relationship"
          },
          "subscriber": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityFlatSubscriber"
              },
              {
                "type": "null"
              }
            ],
            "description": "The policy holder, when relationship is spouse, child or other."
          },
          "view": {
            "anyOf": [
              {
                "enum": [
                  "complete",
                  "summary",
                  "payer",
                  "lines"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The answer view, once the v3 response ships.",
            "title": "View"
          },
          "visit_date": {
            "anyOf": [
              {
                "format": "date",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Defaults to today (UTC).",
            "title": "Visit Date"
          }
        },
        "required": [
          "insurance",
          "member_id",
          "patient"
        ],
        "title": "EligibilityFlatRequest",
        "type": "object"
      },
      "EligibilityFlatSubscriber": {
        "additionalProperties": false,
        "description": "The policy holder, when the patient is not the policy holder. PHI.\n\nWhile the organization's posture requires them (the default), all three\nfields are required on a dependent check, exactly as on the other shapes.",
        "properties": {
          "date_of_birth": {
            "anyOf": [
              {
                "format": "date",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "YYYY-MM-DD, YYYYMMDD or MM/DD/YYYY.",
            "title": "Date Of Birth"
          },
          "first_name": {
            "anyOf": [
              {
                "maxLength": 35,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "First Name"
          },
          "last_name": {
            "anyOf": [
              {
                "maxLength": 60,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Name"
          }
        },
        "title": "EligibilityFlatSubscriber",
        "type": "object"
      },
      "EligibilityFullAnswer": {
        "additionalProperties": true,
        "description": "Readable fields at the top level, with the source projection in payer_answer.",
        "properties": {
          "also_sent": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Also Sent"
          },
          "contract": {
            "const": "eligibility.v2",
            "title": "Contract",
            "type": "string"
          },
          "eligibility_id": {
            "title": "Eligibility Id",
            "type": "string"
          },
          "excluded": {
            "description": "Excluded transport metadata paths, not omitted benefits.",
            "items": {
              "type": "string"
            },
            "title": "Excluded",
            "type": "array"
          },
          "facility_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Facility Id"
          },
          "format_rules": {
            "additionalProperties": {
              "type": "string"
            },
            "title": "Format Rules",
            "type": "object"
          },
          "member": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityPersonAnswer"
              },
              {
                "type": "null"
              }
            ]
          },
          "not_returned": {
            "description": "Expected section keys that were absent or empty in this readable answer. Not a global assertion that the payer supplied no related fact; distinct from the deprecated check-summary field.",
            "items": {
              "type": "string"
            },
            "title": "Not Returned",
            "type": "array"
          },
          "office": {
            "title": "Office",
            "type": "string"
          },
          "outcome": {
            "$ref": "#/components/schemas/EligibilityAnswerOutcome"
          },
          "payer": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Payer"
          },
          "payer_answer": {
            "additionalProperties": true,
            "title": "Payer Answer",
            "type": "object"
          },
          "payer_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Payer Id"
          },
          "plan": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Plan"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "requested": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Requested identity, separate from returned people.",
            "title": "Requested"
          },
          "retrieved_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Retrieved At"
          },
          "section_titles": {
            "additionalProperties": {
              "type": "string"
            },
            "title": "Section Titles",
            "type": "object"
          },
          "sections": {
            "additionalProperties": {
              "items": {
                "$ref": "#/components/schemas/EligibilitySourceRow"
              },
              "type": "array"
            },
            "title": "Sections",
            "type": "object"
          },
          "service_date": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Recorded requested date, not a payer-evaluated date.",
            "title": "Service Date"
          },
          "service_date_source": {
            "anyOf": [
              {
                "const": "request",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Service Date Source"
          },
          "subscriber": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityPersonAnswer"
              },
              {
                "type": "null"
              }
            ]
          },
          "truth": {
            "$ref": "#/components/schemas/EligibilityTruth"
          },
          "unknown_fields": {
            "items": {
              "type": "string"
            },
            "title": "Unknown Fields",
            "type": "array"
          }
        },
        "required": [
          "request_id",
          "eligibility_id",
          "contract",
          "outcome",
          "truth",
          "office",
          "payer_answer"
        ],
        "title": "EligibilityFullAnswer",
        "type": "object"
      },
      "EligibilityListPage": {
        "additionalProperties": true,
        "properties": {
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "results": {
            "items": {
              "$ref": "#/components/schemas/EligibilityListRow"
            },
            "title": "Results",
            "type": "array"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "results"
        ],
        "title": "EligibilityListPage",
        "type": "object"
      },
      "EligibilityListRow": {
        "additionalProperties": true,
        "properties": {
          "billing": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityBilling"
              },
              {
                "type": "null"
              }
            ]
          },
          "eligibility_id": {
            "title": "Eligibility Id",
            "type": "string"
          }
        },
        "required": [
          "eligibility_id",
          "billing"
        ],
        "title": "EligibilityListRow",
        "type": "object"
      },
      "EligibilityOperation": {
        "additionalProperties": true,
        "properties": {
          "eligibility_id": {
            "title": "Eligibility Id",
            "type": "string"
          },
          "environment": {
            "enum": [
              "test",
              "production"
            ],
            "title": "Environment",
            "type": "string"
          },
          "facility_id": {
            "title": "Facility Id",
            "type": "string"
          },
          "pdf": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityPdfMetadata"
              },
              {
                "type": "null"
              }
            ]
          },
          "request_archived": {
            "title": "Request Archived",
            "type": "boolean"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "request_reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Request Reference"
          },
          "response_archived": {
            "type": "boolean"
          },
          "response_mode": {
            "type": "string"
          },
          "result_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Result Id"
          },
          "state": {
            "description": "Durable operation state, not insurance coverage. UNCERTAIN requires reconciliation of the same intent.",
            "enum": [
              "RESERVED",
              "RAW_ARCHIVED",
              "COMPLETE",
              "CACHED",
              "FAILED",
              "UNCERTAIN"
            ],
            "title": "State",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "request_reference",
          "eligibility_id",
          "facility_id",
          "environment",
          "state",
          "response_mode",
          "result_id",
          "request_archived",
          "response_archived",
          "pdf"
        ],
        "title": "EligibilityOperation",
        "type": "object"
      },
      "EligibilityPayer": {
        "additionalProperties": false,
        "description": "Everything the caller knows about the payer. Every field is\noptional; send whatever you have. ``id`` is a Claim House payer id or any\npayer id you hold; ``pms_carrier_id`` the practice system's own payer id;\n``name`` the insurance name as the office records it. ``group_number``\nand ``employer_name`` are kept as evidence for payer matching and are\nnever sent to the payer from here.",
        "properties": {
          "employer_name": {
            "anyOf": [
              {
                "maxLength": 120,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Employer Name"
          },
          "group_number": {
            "anyOf": [
              {
                "maxLength": 50,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Group Number"
          },
          "id": {
            "anyOf": [
              {
                "minLength": 1,
                "pattern": "^[A-Za-z0-9.\\-_ ]{1,80}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Id"
          },
          "name": {
            "anyOf": [
              {
                "maxLength": 120,
                "minLength": 1,
                "pattern": "^[^\\x00-\\x1f]+$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Name"
          },
          "pms_carrier_id": {
            "anyOf": [
              {
                "minLength": 1,
                "pattern": "^[A-Za-z0-9.\\-_ ]{1,80}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Pms Carrier Id"
          }
        },
        "title": "EligibilityPayer",
        "type": "object"
      },
      "EligibilityPayerAnswer": {
        "additionalProperties": true,
        "description": "Customer source projection with excluded transport metadata removed; not original archive bytes.",
        "properties": {
          "eligibility_id": {
            "title": "Eligibility Id",
            "type": "string"
          },
          "payer_answer": {
            "additionalProperties": true,
            "title": "Payer Answer",
            "type": "object"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          }
        },
        "required": [
          "request_id",
          "eligibility_id",
          "payer_answer"
        ],
        "title": "EligibilityPayerAnswer",
        "type": "object"
      },
      "EligibilityPdfCreated": {
        "additionalProperties": true,
        "properties": {
          "artifact_id": {
            "title": "Artifact Id",
            "type": "string"
          },
          "bytes": {
            "title": "Bytes",
            "type": "integer"
          },
          "contract": {
            "anyOf": [
              {
                "const": "eligibility.v3",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "On the v3 PDFs (kind complete or streamlined); absent on the 2026-10-01 PDF.",
            "title": "Contract"
          },
          "eligibility_id": {
            "title": "Eligibility Id",
            "type": "string"
          },
          "filename": {
            "title": "Filename",
            "type": "string"
          },
          "kind": {
            "anyOf": [
              {
                "enum": [
                  "complete",
                  "streamlined"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "complete: every line of the answer. streamlined: the lines the summary view selects. Absent on the 2026-10-01 PDF.",
            "title": "Kind"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "eligibility_id",
          "artifact_id",
          "filename",
          "bytes",
          "request_id"
        ],
        "title": "EligibilityPdfCreated",
        "type": "object"
      },
      "EligibilityPdfDownload": {
        "additionalProperties": true,
        "properties": {
          "artifact_id": {
            "title": "Artifact Id",
            "type": "string"
          },
          "bytes": {
            "title": "Bytes",
            "type": "integer"
          },
          "contract": {
            "anyOf": [
              {
                "const": "eligibility.v3",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "On the v3 PDFs (kind complete or streamlined); absent on the 2026-10-01 PDF.",
            "title": "Contract"
          },
          "download_url": {
            "description": "Short-lived HTTPS URL. Do not forward the API credential to this host.",
            "title": "Download Url",
            "type": "string"
          },
          "eligibility_id": {
            "title": "Eligibility Id",
            "type": "string"
          },
          "expires_in_seconds": {
            "title": "Expires In Seconds",
            "type": "integer"
          },
          "filename": {
            "title": "Filename",
            "type": "string"
          },
          "kind": {
            "anyOf": [
              {
                "enum": [
                  "complete",
                  "streamlined"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "complete: every line of the answer. streamlined: the lines the summary view selects. Absent on the 2026-10-01 PDF.",
            "title": "Kind"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "eligibility_id",
          "artifact_id",
          "filename",
          "bytes",
          "request_id",
          "download_url",
          "expires_in_seconds"
        ],
        "title": "EligibilityPdfDownload",
        "type": "object"
      },
      "EligibilityPdfMetadata": {
        "additionalProperties": true,
        "properties": {
          "artifact_id": {
            "title": "Artifact Id",
            "type": "string"
          },
          "bytes": {
            "title": "Bytes",
            "type": "integer"
          },
          "contract": {
            "anyOf": [
              {
                "const": "eligibility.v3",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "On the v3 PDFs (kind complete or streamlined); absent on the 2026-10-01 PDF.",
            "title": "Contract"
          },
          "eligibility_id": {
            "title": "Eligibility Id",
            "type": "string"
          },
          "filename": {
            "title": "Filename",
            "type": "string"
          },
          "kind": {
            "anyOf": [
              {
                "enum": [
                  "complete",
                  "streamlined"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "complete: every line of the answer. streamlined: the lines the summary view selects. Absent on the 2026-10-01 PDF.",
            "title": "Kind"
          }
        },
        "required": [
          "eligibility_id",
          "artifact_id",
          "filename",
          "bytes"
        ],
        "title": "EligibilityPdfMetadata",
        "type": "object"
      },
      "EligibilityPersonAnswer": {
        "additionalProperties": true,
        "properties": {
          "as_sent": {
            "additionalProperties": true,
            "title": "As Sent",
            "type": "object"
          },
          "coverage": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Coverage"
          },
          "is_subscriber": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Is Subscriber"
          }
        },
        "required": [
          "as_sent"
        ],
        "title": "EligibilityPersonAnswer",
        "type": "object"
      },
      "EligibilityPersonBody": {
        "description": "A subscriber or dependent as the partner identifies them. PHI, never logged.\n\nThe subscriber of a dependent check may leave ``first_name``,\n``last_name`` and ``date_of_birth`` out; ``EligibilityBody``\nrequires them everywhere else. Left out is absent from the payer request,\nnever a blank string.",
        "properties": {
          "date_of_birth": {
            "anyOf": [
              {
                "format": "date",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "YYYY-MM-DD, YYYYMMDD or MM/DD/YYYY.",
            "title": "Date Of Birth"
          },
          "first_name": {
            "anyOf": [
              {
                "maxLength": 35,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "First Name"
          },
          "group_number": {
            "anyOf": [
              {
                "maxLength": 50,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Group Number"
          },
          "last_name": {
            "anyOf": [
              {
                "maxLength": 60,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Name"
          },
          "member_id": {
            "anyOf": [
              {
                "maxLength": 80,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Member Id"
          },
          "relationship": {
            "anyOf": [
              {
                "enum": [
                  "spouse",
                  "child",
                  "other"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Required for a dependent; never sent for the subscriber. Also takes the X12 code (01 spouse, 19 child, other dependent codes other) and any letter case.",
            "title": "Relationship"
          }
        },
        "title": "EligibilityPersonBody",
        "type": "object"
      },
      "EligibilityProvider": {
        "additionalProperties": true,
        "description": "Accepted for compatibility. The facility's registered NPI is the\nprovider identity the gateway sends; a different npi here is refused.",
        "properties": {
          "firstName": {
            "anyOf": [
              {
                "maxLength": 35,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Firstname"
          },
          "lastName": {
            "anyOf": [
              {
                "maxLength": 60,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Lastname"
          },
          "npi": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Npi"
          },
          "organizationName": {
            "anyOf": [
              {
                "maxLength": 60,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Organizationname"
          },
          "taxId": {
            "anyOf": [
              {
                "pattern": "^\\d{9}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Taxid"
          }
        },
        "title": "EligibilityProvider",
        "type": "object"
      },
      "EligibilityReadResponse": {
        "additionalProperties": true,
        "description": "``GET /v1/eligibility/{eligibility_id}``: one check, with what the request\nsent that the summary does not carry, enough to rebuild and replay it.",
        "properties": {
          "billing": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityBilling"
              },
              {
                "type": "null"
              }
            ],
            "description": "Null only for a check recorded before usage metering began."
          },
          "cache": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityCache"
              },
              {
                "type": "null"
              }
            ]
          },
          "eligibility_id": {
            "title": "Eligibility Id",
            "type": "string"
          },
          "facility_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Facility Id"
          },
          "group_number": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The subscriber group number sent on the request (not the payer's plan.group_number); null when none was sent.",
            "title": "Group Number"
          },
          "idempotency_key": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The Idempotency-Key the check was sent with.",
            "title": "Idempotency Key"
          },
          "mode": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The detail level: standard or enhanced.",
            "title": "Mode"
          },
          "outcome": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Outcome"
          },
          "payer_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Payer Id"
          },
          "procedure_codes": {
            "description": "The procedure codes sent on the request.",
            "items": {
              "type": "string"
            },
            "title": "Procedure Codes",
            "type": "array"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "retrieved_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the payer answered.",
            "title": "Retrieved At"
          },
          "service_date": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Service Date"
          },
          "status": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Status"
          },
          "tenant_reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Tenant Reference"
          }
        },
        "required": [
          "request_id",
          "eligibility_id",
          "billing",
          "idempotency_key",
          "group_number",
          "procedure_codes"
        ],
        "title": "EligibilityReadResponse",
        "type": "object"
      },
      "EligibilityReadableAnswer": {
        "additionalProperties": true,
        "description": "Complete source-labeled answer. Optional sections can be absent on a refusal.\n\nUnknown source keys remain in as_sent and extension fields. Missing structured\nvalues never establish absent coverage. Dates in source records retain their literals.",
        "properties": {
          "also_sent": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Also Sent"
          },
          "contract": {
            "const": "eligibility.v2",
            "title": "Contract",
            "type": "string"
          },
          "eligibility_id": {
            "title": "Eligibility Id",
            "type": "string"
          },
          "excluded": {
            "description": "Excluded transport metadata paths, not omitted benefits.",
            "items": {
              "type": "string"
            },
            "title": "Excluded",
            "type": "array"
          },
          "facility_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Facility Id"
          },
          "format_rules": {
            "additionalProperties": {
              "type": "string"
            },
            "title": "Format Rules",
            "type": "object"
          },
          "member": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityPersonAnswer"
              },
              {
                "type": "null"
              }
            ]
          },
          "not_returned": {
            "description": "Expected section keys that were absent or empty in this readable answer. Not a global assertion that the payer supplied no related fact; distinct from the deprecated check-summary field.",
            "items": {
              "type": "string"
            },
            "title": "Not Returned",
            "type": "array"
          },
          "office": {
            "title": "Office",
            "type": "string"
          },
          "outcome": {
            "$ref": "#/components/schemas/EligibilityAnswerOutcome"
          },
          "payer": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Payer"
          },
          "payer_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Payer Id"
          },
          "plan": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Plan"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "requested": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Requested identity, separate from returned people.",
            "title": "Requested"
          },
          "retrieved_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Retrieved At"
          },
          "section_titles": {
            "additionalProperties": {
              "type": "string"
            },
            "title": "Section Titles",
            "type": "object"
          },
          "sections": {
            "additionalProperties": {
              "items": {
                "$ref": "#/components/schemas/EligibilitySourceRow"
              },
              "type": "array"
            },
            "title": "Sections",
            "type": "object"
          },
          "service_date": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Recorded requested date, not a payer-evaluated date.",
            "title": "Service Date"
          },
          "service_date_source": {
            "anyOf": [
              {
                "const": "request",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Service Date Source"
          },
          "subscriber": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityPersonAnswer"
              },
              {
                "type": "null"
              }
            ]
          },
          "truth": {
            "$ref": "#/components/schemas/EligibilityTruth"
          },
          "unknown_fields": {
            "items": {
              "type": "string"
            },
            "title": "Unknown Fields",
            "type": "array"
          }
        },
        "required": [
          "request_id",
          "eligibility_id",
          "contract",
          "outcome",
          "truth",
          "office"
        ],
        "title": "EligibilityReadableAnswer",
        "type": "object"
      },
      "EligibilityRecordFacts": {
        "additionalProperties": true,
        "properties": {
          "group_number": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The group number sent on the request.",
            "title": "Group Number"
          },
          "idempotency_key": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Idempotency Key"
          },
          "procedures": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "The procedure codes sent on the request.",
            "title": "Procedures"
          },
          "reference": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reference"
          }
        },
        "title": "EligibilityRecordFacts",
        "type": "object"
      },
      "EligibilityRecordV3": {
        "additionalProperties": true,
        "description": "``GET /v1/eligibility/{eligibility_id}`` under API version 2026-11-01.",
        "properties": {
          "as_requested": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3AsRequested"
              },
              {
                "type": "null"
              }
            ]
          },
          "billing": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Billing"
          },
          "by_procedure": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Procedure"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "By Procedure"
          },
          "by_service": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Service"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "By Service"
          },
          "checked_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Checked At"
          },
          "contract": {
            "const": "eligibility.v3",
            "title": "Contract",
            "type": "string"
          },
          "counts": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Counts"
              },
              {
                "type": "null"
              }
            ]
          },
          "dependents": {
            "anyOf": [
              {
                "items": {
                  "additionalProperties": true,
                  "type": "object"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Dependents"
          },
          "excluded": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Excluded"
          },
          "failure": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "A check the payer did not answer (status not_answered): error_class and, when the payer refused, rejection.",
            "title": "Failure"
          },
          "history": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3HistoryEntry"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "History"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "labels": {
            "anyOf": [
              {
                "additionalProperties": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "type": "object"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Plain words for the payer tokens in this answer.",
            "title": "Labels"
          },
          "lines": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Lines view only: every line once, each with its group (for example by_procedure/D1110).",
            "title": "Lines"
          },
          "links": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Links"
              },
              {
                "type": "null"
              }
            ]
          },
          "missing": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Sections an office usually expects that the payer did not send.",
            "title": "Missing"
          },
          "not_covered": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Not Covered"
          },
          "not_read": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Fields kept verbatim under a line's other, not organized.",
            "title": "Not Read"
          },
          "notes": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Notes"
          },
          "office": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Office"
              },
              {
                "type": "null"
              }
            ]
          },
          "other": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Other"
          },
          "patient": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "As returned by the payer.",
            "title": "Patient"
          },
          "payer": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Payer"
              },
              {
                "type": "null"
              }
            ]
          },
          "payer_answer": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "A check sent with view payer only: the payer's answer as received (transport metadata removed).",
            "title": "Payer Answer"
          },
          "plan": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Plan"
              },
              {
                "type": "null"
              }
            ]
          },
          "rejection": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rejection"
          },
          "request": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityRecordFacts"
              },
              {
                "type": "null"
              }
            ]
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "status": {
            "enum": [
              "active",
              "inactive",
              "unknown",
              "not_answered"
            ],
            "title": "Status",
            "type": "string"
          },
          "subscriber": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "As returned by the payer.",
            "title": "Subscriber"
          },
          "summary": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Summary view only: the blocks and codes shown and where each choice came from.",
            "title": "Summary"
          },
          "totals": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Totals"
              },
              {
                "type": "null"
              }
            ]
          },
          "unverified_reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Only with verified false: why the organized answer is withheld. links.payer_answer still answers.",
            "title": "Unverified Reason"
          },
          "verified": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Verified"
          },
          "view": {
            "anyOf": [
              {
                "enum": [
                  "complete",
                  "summary",
                  "lines",
                  "payer"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The view served. Absent only on a check the payer did not answer (there is no answer to view).",
            "title": "View"
          }
        },
        "required": [
          "request_id",
          "id",
          "contract",
          "status"
        ],
        "title": "EligibilityRecordV3",
        "type": "object"
      },
      "EligibilitySourceRow": {
        "additionalProperties": true,
        "properties": {
          "as_sent": {
            "description": "Original source row, including unknown fields or a non-object literal.",
            "title": "As Sent"
          },
          "codes": {
            "items": {
              "type": "string"
            },
            "title": "Codes",
            "type": "array"
          },
          "labels": {
            "additionalProperties": true,
            "title": "Labels",
            "type": "object"
          },
          "reads_as": {
            "description": "Source-attributed readable text, not inferred coverage.",
            "title": "Reads As",
            "type": "string"
          },
          "row": {
            "title": "Row",
            "type": "integer"
          },
          "unknown_fields": {
            "items": {
              "type": "string"
            },
            "title": "Unknown Fields",
            "type": "array"
          }
        },
        "required": [
          "row",
          "as_sent",
          "labels",
          "codes",
          "reads_as"
        ],
        "title": "EligibilitySourceRow",
        "type": "object"
      },
      "EligibilitySubscriber": {
        "additionalProperties": false,
        "description": "PHI: never logged, never echoed.\n\nOn a dependent check the subscriber's ``firstName``, ``lastName`` and\n``dateOfBirth`` may be left out; ``EligibilityCheckRequest``\nrequires them on a subscriber-only check. Left out means absent from the\npayer request, never a blank string.",
        "properties": {
          "dateOfBirth": {
            "title": "Dateofbirth",
            "type": "string"
          },
          "firstName": {
            "maxLength": 35,
            "minLength": 1,
            "title": "Firstname",
            "type": "string"
          },
          "groupNumber": {
            "anyOf": [
              {
                "maxLength": 50,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Groupnumber"
          },
          "lastName": {
            "maxLength": 60,
            "minLength": 1,
            "title": "Lastname",
            "type": "string"
          },
          "memberId": {
            "maxLength": 80,
            "title": "Memberid",
            "type": "string"
          }
        },
        "required": [
          "memberId",
          "firstName",
          "lastName",
          "dateOfBirth"
        ],
        "title": "EligibilitySubscriber",
        "type": "object"
      },
      "EligibilitySummarySelection": {
        "additionalProperties": true,
        "properties": {
          "blocks": {
            "items": {
              "type": "string"
            },
            "title": "Blocks",
            "type": "array"
          },
          "procedures": {
            "items": {
              "type": "string"
            },
            "title": "Procedures",
            "type": "array"
          },
          "source": {
            "anyOf": [
              {
                "additionalProperties": {
                  "type": "string"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Source"
          }
        },
        "required": [
          "blocks",
          "procedures"
        ],
        "title": "EligibilitySummarySelection",
        "type": "object"
      },
      "EligibilitySummarySettingsBody": {
        "additionalProperties": false,
        "description": "The blocks and CDT codes the summary view shows.",
        "properties": {
          "blocks": {
            "description": "Summary blocks, in any order.",
            "items": {
              "type": "string"
            },
            "maxItems": 32,
            "title": "Blocks",
            "type": "array"
          },
          "procedures": {
            "description": "CDT codes such as D1110.",
            "items": {
              "type": "string"
            },
            "maxItems": 200,
            "title": "Procedures",
            "type": "array"
          }
        },
        "required": [
          "blocks",
          "procedures"
        ],
        "title": "EligibilitySummarySettingsBody",
        "type": "object"
      },
      "EligibilitySummarySettingsView": {
        "additionalProperties": true,
        "description": "``GET`` and ``PUT /v1/settings/eligibility-summary``.",
        "properties": {
          "blocks_available": {
            "items": {
              "type": "string"
            },
            "title": "Blocks Available",
            "type": "array"
          },
          "defaults": {
            "$ref": "#/components/schemas/EligibilitySummarySelection"
          },
          "effective": {
            "$ref": "#/components/schemas/EligibilitySummarySelection"
          },
          "facility_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Facility Id"
          },
          "office": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "With facility_id: the office's saved setting, or null.",
            "title": "Office"
          },
          "organization": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "The organization's saved setting, or null.",
            "title": "Organization"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "saved": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "PUT only: the setting just saved.",
            "title": "Saved"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "organization",
          "effective",
          "defaults",
          "blocks_available"
        ],
        "title": "EligibilitySummarySettingsView",
        "type": "object"
      },
      "EligibilityTruth": {
        "additionalProperties": true,
        "properties": {
          "checked": {
            "title": "Checked",
            "type": "integer"
          },
          "defects": {
            "title": "Defects",
            "type": "integer"
          },
          "ok": {
            "title": "Ok",
            "type": "boolean"
          }
        },
        "required": [
          "checked",
          "defects",
          "ok"
        ],
        "title": "EligibilityTruth",
        "type": "object"
      },
      "EligibilityV3AsRequested": {
        "additionalProperties": true,
        "properties": {
          "differences": {
            "description": "Fields the payer returned with another value than was sent.",
            "items": {
              "type": "string"
            },
            "title": "Differences",
            "type": "array"
          },
          "not_returned": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Fields, or a whole person, that were sent and the payer did not return. Missing is never a match.",
            "title": "Not Returned"
          },
          "patient": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Patient"
          },
          "relationship": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Relationship"
          },
          "subscriber": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Subscriber"
          },
          "visit_date": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Visit Date"
          }
        },
        "required": [
          "differences"
        ],
        "title": "EligibilityV3AsRequested",
        "type": "object"
      },
      "EligibilityV3Counts": {
        "additionalProperties": true,
        "properties": {
          "complete_lines": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Summary view: lines in the complete answer.",
            "title": "Complete Lines"
          },
          "lines": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Complete and lines views: always equal to payer_rows.",
            "title": "Lines"
          },
          "payer_rows": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Complete and lines views: rows in the payer's answer.",
            "title": "Payer Rows"
          },
          "shown_lines": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Summary view: lines this summary shows.",
            "title": "Shown Lines"
          }
        },
        "title": "EligibilityV3Counts",
        "type": "object"
      },
      "EligibilityV3Coverage": {
        "additionalProperties": true,
        "properties": {
          "end": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "End"
          },
          "lines": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Lines"
          },
          "start": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Start"
          },
          "status": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Status"
          },
          "termination": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Termination"
          }
        },
        "title": "EligibilityV3Coverage",
        "type": "object"
      },
      "EligibilityV3HistoryEntry": {
        "additionalProperties": true,
        "properties": {
          "code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Code"
          },
          "date": {
            "description": "YYYY-MM-DD when the payer sent a clean date; else as sent.",
            "title": "Date",
            "type": "string"
          },
          "ref": {
            "title": "Ref",
            "type": "string"
          },
          "type": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The payer's date type as sent, for example service.",
            "title": "Type"
          }
        },
        "required": [
          "date",
          "ref"
        ],
        "title": "EligibilityV3HistoryEntry",
        "type": "object"
      },
      "EligibilityV3Line": {
        "additionalProperties": true,
        "description": "One payer row, exactly once. Qualifier fields exist only when the payer's\nrow carries their key (renamed 1:1: network, coverage_level as level,\nplan_period as period, service_type as service, limitation as limit,\nquantity_qualifier as quantity_unit, age_limit as age,\nhealth_service_descriptions as frequency, payer_specific_description as\nnote, and the rest by their own names).",
        "properties": {
          "amount": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Money exactly as sent, a decimal string such as \"50.00\".",
            "title": "Amount"
          },
          "code_as_sent": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Under by_procedure, when the payer spelled the group's code several ways: this row's spelling.",
            "title": "Code As Sent"
          },
          "kind": {
            "description": "The payer section the row came from, for example coinsurance, deductible, maximum, limitation, not_covered, active_coverage.",
            "title": "Kind",
            "type": "string"
          },
          "level": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Level"
          },
          "network": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Network"
          },
          "other": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Fields of this row Claim House did not organize, verbatim. Listed in not_read.",
            "title": "Other"
          },
          "percent": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "number"
              },
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "A number when the payer sent a plain number that writes back exactly; else the string as sent.",
            "title": "Percent"
          },
          "period": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Period"
          },
          "ref": {
            "description": "The payer section and row index, for example coinsurance[14]; the same index as view=payer.",
            "title": "Ref",
            "type": "string"
          },
          "service": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Service"
          },
          "shared_with": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "description": "Under by_procedure, for a row naming several codes: the other codes it is also listed under. The row is counted once.",
            "title": "Shared With"
          },
          "text": {
            "description": "One plain sentence holding every value on the line, exactly as sent. Coinsurance reads \"coinsurance N%\" and never says whose share it is.",
            "title": "Text",
            "type": "string"
          }
        },
        "required": [
          "kind",
          "text",
          "ref"
        ],
        "title": "EligibilityV3Line",
        "type": "object"
      },
      "EligibilityV3Links": {
        "additionalProperties": true,
        "properties": {
          "complete": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Complete"
          },
          "lines": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Lines"
          },
          "payer_answer": {
            "title": "Payer Answer",
            "type": "string"
          },
          "pdf": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Pdf"
          },
          "summary": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Summary"
          }
        },
        "required": [
          "payer_answer"
        ],
        "title": "EligibilityV3Links",
        "type": "object"
      },
      "EligibilityV3Office": {
        "additionalProperties": true,
        "properties": {
          "id": {
            "title": "Id",
            "type": "string"
          },
          "name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Name"
          }
        },
        "required": [
          "id"
        ],
        "title": "EligibilityV3Office",
        "type": "object"
      },
      "EligibilityV3Payer": {
        "additionalProperties": true,
        "properties": {
          "id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Id"
          },
          "id_as_returned": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Id As Returned"
          },
          "name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Claim House's directory name for the payer.",
            "title": "Name"
          },
          "name_as_returned": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The payer's own name, as returned.",
            "title": "Name As Returned"
          }
        },
        "title": "EligibilityV3Payer",
        "type": "object"
      },
      "EligibilityV3Plan": {
        "additionalProperties": true,
        "properties": {
          "coverage": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/EligibilityV3Coverage"
              },
              {
                "type": "null"
              }
            ]
          },
          "group_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Group Name"
          },
          "group_number": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Group Number"
          },
          "name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Name"
          },
          "notes": {
            "anyOf": [
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Notes"
          },
          "type": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Type"
          }
        },
        "title": "EligibilityV3Plan",
        "type": "object"
      },
      "EligibilityV3Procedure": {
        "additionalProperties": true,
        "properties": {
          "code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The bare CDT code when the payer sent one qualifier and one code (AD:D1110 reads D1110). Codes only: no names.",
            "title": "Code"
          },
          "code_as_sent": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The procedure value exactly as the payer sent it. When the payer spelled one code several ways, it is on each line instead.",
            "title": "Code As Sent"
          },
          "history": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3HistoryEntry"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "History"
          },
          "lines": {
            "items": {
              "$ref": "#/components/schemas/EligibilityV3Line"
            },
            "title": "Lines",
            "type": "array"
          }
        },
        "required": [
          "lines"
        ],
        "title": "EligibilityV3Procedure",
        "type": "object"
      },
      "EligibilityV3Service": {
        "additionalProperties": true,
        "properties": {
          "label": {
            "title": "Label",
            "type": "string"
          },
          "lines": {
            "items": {
              "$ref": "#/components/schemas/EligibilityV3Line"
            },
            "title": "Lines",
            "type": "array"
          },
          "service": {
            "description": "The payer's service type as sent; not_stated when the payer sent none.",
            "title": "Service",
            "type": "string"
          }
        },
        "required": [
          "service",
          "label",
          "lines"
        ],
        "title": "EligibilityV3Service",
        "type": "object"
      },
      "EligibilityV3Totals": {
        "additionalProperties": true,
        "properties": {
          "deductibles": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Deductibles"
          },
          "maximums": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Maximums"
          },
          "out_of_pocket": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/EligibilityV3Line"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "title": "Out Of Pocket"
          }
        },
        "title": "EligibilityV3Totals",
        "type": "object"
      },
      "Error": {
        "title": "Error",
        "type": "object",
        "description": "Every refusal has this body. `error` is the stable code to branch on; `message` is for developers and may change. Retry only when `retryable` is true, with the same request and the same Idempotency-Key, after `retry_after_seconds`. Every code: https://docs.claimhouse.ai/#guide-errors",
        "required": [
          "error",
          "message",
          "errors",
          "request_id",
          "retryable",
          "retry_after_seconds",
          "next_step",
          "doc_url",
          "user_message"
        ],
        "properties": {
          "error": {
            "type": "string",
            "description": "The error code, for example `INVALID_REQUEST`."
          },
          "message": {
            "type": "string",
            "description": "What went wrong, for developers."
          },
          "errors": {
            "type": "array",
            "description": "Details, for example the fields to fix. Often empty.",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "request_id": {
            "type": "string",
            "description": "This request's id, also in `X-Request-Id`."
          },
          "retryable": {
            "type": "boolean",
            "description": "True only for a 429, 503 CAPACITY and 409 ELIGIBILITY_OPERATION_PENDING: resend the same request with the same Idempotency-Key."
          },
          "retry_after_seconds": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Seconds to wait when Claim House knows it (the Retry-After header); else null."
          },
          "next_step": {
            "type": "string",
            "enum": [
              "RESEND_SAME_REQUEST",
              "FIX_REQUEST",
              "NEW_CHECK_LATER",
              "CHOOSE_PAYER",
              "CONTACT_SUPPORT",
              "COMPLETE_SETUP",
              "NONE"
            ],
            "description": "What to do next; one of next_steps."
          },
          "doc_url": {
            "type": "string",
            "format": "uri",
            "description": "This error's anchor in the docs."
          },
          "user_message": {
            "type": "string",
            "description": "A sentence safe to show a front desk. For a payer rejection, the rejection summary."
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "additionalProperties": true,
        "example": {
          "error": "IDEMPOTENCY_KEY_REQUIRED",
          "message": "the Idempotency-Key header is required",
          "errors": [],
          "request_id": "evt_EXAMPLE0000000000001",
          "retryable": false,
          "retry_after_seconds": null,
          "next_step": "FIX_REQUEST",
          "doc_url": "https://docs.claimhouse.ai/#error-idempotency-key-required",
          "user_message": "Some details in this request need to be corrected before it can be sent.",
          "livemode": false
        }
      },
      "FacilityCreateBody": {
        "additionalProperties": false,
        "description": "`POST /v1/facilities` and one row of `POST /v1/facilities/import`.\n\nPractice data only. ``bindingKind`` is always ``sandbox`` on create:\nproduction arming stays an operator action, never an API call.",
        "properties": {
          "addressLine1": {
            "default": "",
            "maxLength": 240,
            "title": "Addressline1",
            "type": "string"
          },
          "addressLine2": {
            "default": "",
            "maxLength": 240,
            "title": "Addressline2",
            "type": "string"
          },
          "billingNpi": {
            "pattern": "^\\d{10}$",
            "title": "Billingnpi",
            "type": "string"
          },
          "city": {
            "default": "",
            "maxLength": 120,
            "title": "City",
            "type": "string"
          },
          "claimOfficeCode": {
            "anyOf": [
              {
                "pattern": "^[A-Z][A-Z0-9]{1,7}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Claimofficecode"
          },
          "claimTimezone": {
            "anyOf": [
              {
                "maxLength": 64,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Claimtimezone"
          },
          "contactEmail": {
            "default": "",
            "maxLength": 254,
            "title": "Contactemail",
            "type": "string"
          },
          "contactName": {
            "default": "",
            "maxLength": 160,
            "title": "Contactname",
            "type": "string"
          },
          "contactPhone": {
            "default": "",
            "maxLength": 40,
            "title": "Contactphone",
            "type": "string"
          },
          "controlPrefix": {
            "anyOf": [
              {
                "maxLength": 4,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Controlprefix"
          },
          "country": {
            "default": "US",
            "maxLength": 2,
            "minLength": 2,
            "title": "Country",
            "type": "string"
          },
          "displayName": {
            "default": "",
            "maxLength": 240,
            "title": "Displayname",
            "type": "string"
          },
          "groupId": {
            "anyOf": [
              {
                "maxLength": 64,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Groupid"
          },
          "legalName": {
            "anyOf": [
              {
                "maxLength": 240,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Legalname"
          },
          "neaFacilityId": {
            "anyOf": [
              {
                "maxLength": 64,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Neafacilityid"
          },
          "officeId": {
            "anyOf": [
              {
                "maxLength": 64,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Officeid"
          },
          "partnerOfficeRef": {
            "anyOf": [
              {
                "maxLength": 120,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Partnerofficeref"
          },
          "postalCode": {
            "default": "",
            "maxLength": 24,
            "title": "Postalcode",
            "type": "string"
          },
          "state": {
            "default": "",
            "maxLength": 64,
            "title": "State",
            "type": "string"
          },
          "taxonomy": {
            "default": "",
            "maxLength": 10,
            "title": "Taxonomy",
            "type": "string"
          },
          "tin": {
            "pattern": "^\\d{9}$",
            "title": "Tin",
            "type": "string"
          },
          "tinType": {
            "default": "EI",
            "enum": [
              "EI",
              "SY"
            ],
            "title": "Tintype",
            "type": "string"
          }
        },
        "required": [
          "billingNpi",
          "tin"
        ],
        "title": "FacilityCreateBody",
        "type": "object"
      },
      "FacilityImportBody": {
        "additionalProperties": false,
        "description": "`POST /v1/facilities/import`: a batch of facility rows, each judged\non its own so one bad row never sinks the file.",
        "properties": {
          "facilities": {
            "items": {
              "$ref": "#/components/schemas/FacilityCreateBody"
            },
            "maxItems": 500,
            "minItems": 1,
            "title": "Facilities",
            "type": "array"
          }
        },
        "required": [
          "facilities"
        ],
        "title": "FacilityImportBody",
        "type": "object"
      },
      "FacilityList": {
        "additionalProperties": true,
        "properties": {
          "facilities": {
            "items": {
              "$ref": "#/components/schemas/FacilityRecord"
            },
            "title": "Facilities",
            "type": "array"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "facilities"
        ],
        "title": "FacilityList",
        "type": "object"
      },
      "FacilityRecord": {
        "additionalProperties": true,
        "description": "One office. Stored values as captured; ``name`` is the only computed field.",
        "properties": {
          "address_line1": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Address Line1"
          },
          "address_line2": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Address Line2"
          },
          "billing_npi": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Billing Npi"
          },
          "binding_kind": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "sandbox (test) or production (live).",
            "title": "Binding Kind"
          },
          "city": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "City"
          },
          "claim_office_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Claim Office Code"
          },
          "claim_timezone": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Claim Timezone"
          },
          "contact_email": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Contact Email"
          },
          "contact_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Contact Name"
          },
          "contact_phone": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Contact Phone"
          },
          "control_prefix": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The office code.",
            "title": "Control Prefix"
          },
          "country": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Country"
          },
          "display_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Display Name"
          },
          "eligibility_state": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Live for eligibility is a production office with this READY.",
            "title": "Eligibility State"
          },
          "facility_id": {
            "title": "Facility Id",
            "type": "string"
          },
          "group_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Group Id"
          },
          "identity_review_status": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Identity Review Status"
          },
          "legal_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Legal Name"
          },
          "name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Display name, else legal name, else the office code.",
            "title": "Name"
          },
          "nea_facility_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Nea Facility Id"
          },
          "partner_office_ref": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Partner Office Ref"
          },
          "postal_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Postal Code"
          },
          "profile_source": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Profile Source"
          },
          "profile_version": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Profile Version"
          },
          "state": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "State"
          },
          "status": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Status"
          },
          "taxonomy": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Taxonomy"
          },
          "tin_type": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Tin Type"
          }
        },
        "required": [
          "facility_id",
          "name"
        ],
        "title": "FacilityRecord",
        "type": "object"
      },
      "GoLiveResponse": {
        "description": "Where an office's go-live stands.",
        "properties": {
          "customer_message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Claim House's note when a review was declined.",
            "title": "Customer Message"
          },
          "decided_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Decided At"
          },
          "facility_id": {
            "title": "Facility Id",
            "type": "string"
          },
          "reasons": {
            "description": "Why the registry check did not pass: NOT_FOUND, INACTIVE, NOT_DENTAL, NAME_MISMATCH, STATE_MISMATCH or REGISTRY_UNAVAILABLE.",
            "items": {
              "type": "string"
            },
            "title": "Reasons",
            "type": "array"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "state": {
            "description": "sandbox, in_review, live or refused.",
            "title": "State",
            "type": "string"
          },
          "submitted_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Submitted At"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "facility_id",
          "state",
          "reasons",
          "submitted_at",
          "decided_at",
          "customer_message"
        ],
        "title": "GoLiveResponse",
        "type": "object"
      },
      "InvitationPrepareBody": {
        "properties": {
          "actions": {
            "items": {
              "type": "string"
            },
            "maxItems": 100,
            "title": "Actions",
            "type": "array"
          },
          "email": {
            "maxLength": 254,
            "minLength": 3,
            "title": "Email",
            "type": "string"
          },
          "expires_at": {
            "format": "date-time",
            "title": "Expires At",
            "type": "string"
          },
          "office_ids": {
            "items": {
              "type": "string"
            },
            "maxItems": 500,
            "title": "Office Ids",
            "type": "array"
          },
          "role": {
            "enum": [
              "owner",
              "admin",
              "submitter",
              "viewer"
            ],
            "title": "Role",
            "type": "string"
          },
          "scope_kind": {
            "enum": [
              "ALL",
              "SUBSET",
              "NONE"
            ],
            "title": "Scope Kind",
            "type": "string"
          }
        },
        "required": [
          "email",
          "role",
          "scope_kind",
          "expires_at"
        ],
        "title": "InvitationPrepareBody",
        "type": "object"
      },
      "InvitationSendBody": {
        "properties": {
          "confirmed": {
            "title": "Confirmed",
            "type": "boolean"
          },
          "expected_version": {
            "minimum": 1.0,
            "title": "Expected Version",
            "type": "integer"
          }
        },
        "required": [
          "expected_version",
          "confirmed"
        ],
        "title": "InvitationSendBody",
        "type": "object"
      },
      "MePrincipal": {
        "additionalProperties": true,
        "description": "Who is calling: ``kind`` ``api_key`` with ``key_id`` for an API key; a\ndashboard sign-in has its own ``kind`` and a ``subject``.",
        "properties": {
          "key_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The API key's id. Absent for a dashboard sign-in.",
            "title": "Key Id"
          },
          "kind": {
            "description": "api_key for an API key; another value for a dashboard sign-in.",
            "title": "Kind",
            "type": "string"
          },
          "subject": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The dashboard sign-in. Absent for an API key.",
            "title": "Subject"
          }
        },
        "required": [
          "kind"
        ],
        "title": "MePrincipal",
        "type": "object"
      },
      "MeResponse": {
        "additionalProperties": true,
        "description": "Who this credential is. A key and a dashboard session answer the same\nfields; the session-only ones (``user``, ``organization``, ``role``,\n``office_scope``, ``authorization_version``) are null for a key, and the\nkey-only ``scope`` is null for a session.",
        "properties": {
          "authorization_version": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Authorization Version"
          },
          "billing": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Billing"
          },
          "capabilities": {
            "additionalProperties": true,
            "title": "Capabilities",
            "type": "object"
          },
          "entitlements": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "title": "Entitlements",
            "type": "array"
          },
          "live_available": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Live Available"
          },
          "mode": {
            "title": "Mode",
            "type": "string"
          },
          "office_scope": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "The member's office scope. Null for a key.",
            "title": "Office Scope"
          },
          "organization": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "The member's organization. Null for a key.",
            "title": "Organization"
          },
          "permissions": {
            "items": {
              "type": "string"
            },
            "title": "Permissions",
            "type": "array"
          },
          "principal": {
            "$ref": "#/components/schemas/MePrincipal"
          },
          "reachable_facilities": {
            "description": "The same offices with name, code, city, state and mode, in the same order.",
            "items": {
              "$ref": "#/components/schemas/ReachableFacility"
            },
            "title": "Reachable Facilities",
            "type": "array"
          },
          "reachable_facility_ids": {
            "description": "The offices this credential reaches, as ids.",
            "items": {
              "type": "string"
            },
            "title": "Reachable Facility Ids",
            "type": "array"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "role": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Role"
          },
          "scope": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "A key's grant: kind, ids and permissions. Null for a session.",
            "title": "Scope"
          },
          "seller_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Seller Id"
          },
          "seller_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Seller Name"
          },
          "seller_status": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Seller Status"
          },
          "test_usage": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Test Usage"
          },
          "user": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "The signed-in member. Null for a key.",
            "title": "User"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "principal",
          "seller_id",
          "seller_name",
          "seller_status",
          "mode",
          "scope",
          "user",
          "organization",
          "role",
          "permissions",
          "office_scope",
          "reachable_facility_ids",
          "reachable_facilities",
          "authorization_version",
          "capabilities",
          "entitlements"
        ],
        "title": "MeResponse",
        "type": "object"
      },
      "MemberUpdateBody": {
        "properties": {
          "actions": {
            "items": {
              "type": "string"
            },
            "maxItems": 100,
            "title": "Actions",
            "type": "array"
          },
          "expected_version": {
            "minimum": 1.0,
            "title": "Expected Version",
            "type": "integer"
          },
          "office_ids": {
            "items": {
              "type": "string"
            },
            "maxItems": 500,
            "title": "Office Ids",
            "type": "array"
          },
          "reason": {
            "maxLength": 1000,
            "minLength": 3,
            "title": "Reason",
            "type": "string"
          },
          "role": {
            "enum": [
              "owner",
              "admin",
              "submitter",
              "viewer"
            ],
            "title": "Role",
            "type": "string"
          },
          "scope_kind": {
            "enum": [
              "ALL",
              "SUBSET",
              "NONE"
            ],
            "title": "Scope Kind",
            "type": "string"
          }
        },
        "required": [
          "expected_version",
          "role",
          "scope_kind",
          "reason"
        ],
        "title": "MemberUpdateBody",
        "type": "object"
      },
      "PayerAcceptedSearch": {
        "properties": {
          "citation_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Citation Url"
          },
          "note": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Note"
          },
          "search": {
            "description": "MEMBER_ID_NAME_DOB, MEMBER_ID_DOB, NAME_DOB_ONLY, SSN_AS_MEMBER_ID or SSN_WITH_NAME_OR_DOB.",
            "title": "Search",
            "type": "string"
          },
          "source": {
            "enum": [
              "PAYER_GUIDE",
              "OBSERVED",
              "UNKNOWN"
            ],
            "title": "Source",
            "type": "string"
          }
        },
        "required": [
          "search",
          "source"
        ],
        "title": "PayerAcceptedSearch",
        "type": "object"
      },
      "PayerEnrollmentRequired": {
        "description": "Per transaction, whether the provider must enroll with the payer first.",
        "properties": {
          "attachments": {
            "title": "Attachments",
            "type": "boolean"
          },
          "claim_status": {
            "title": "Claim Status",
            "type": "boolean"
          },
          "claims": {
            "title": "Claims",
            "type": "boolean"
          },
          "eligibility": {
            "title": "Eligibility",
            "type": "boolean"
          },
          "remittance": {
            "title": "Remittance",
            "type": "boolean"
          }
        },
        "required": [
          "eligibility",
          "claims",
          "claim_status",
          "remittance",
          "attachments"
        ],
        "title": "PayerEnrollmentRequired",
        "type": "object"
      },
      "PayerHealth": {
        "description": "``GET /v1/payers/{payer_id}/health``: how this payer's eligibility checks\nare going for Claim House as a whole, so a caller can tell \"payer down\" from\na problem in its own request.",
        "properties": {
          "display_name": {
            "title": "Display Name",
            "type": "string"
          },
          "eligibility": {
            "enum": [
              "SUPPORTED",
              "ENROLLMENT_REQUIRED",
              "NOT_SUPPORTED",
              "COMING_SOON"
            ],
            "title": "Eligibility",
            "type": "string"
          },
          "measured": {
            "description": "False when Claim House cannot read its own outcomes right now; every number is then null.",
            "title": "Measured",
            "type": "boolean"
          },
          "minimum_sample": {
            "title": "Minimum Sample",
            "type": "integer"
          },
          "payer_id": {
            "title": "Payer Id",
            "type": "string"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "transaction": {
            "const": "eligibility",
            "default": "eligibility",
            "title": "Transaction",
            "type": "string"
          },
          "windows": {
            "$ref": "#/components/schemas/PayerHealthWindows"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "payer_id",
          "display_name",
          "eligibility",
          "measured",
          "minimum_sample",
          "windows"
        ],
        "title": "PayerHealth",
        "type": "object"
      },
      "PayerHealthWindow": {
        "properties": {
          "answered_rate": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "title": "Answered Rate"
          },
          "checks": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Checks"
          },
          "median_latency_ms": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Median Latency Ms"
          },
          "payer_unavailable_rate": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "title": "Payer Unavailable Rate"
          },
          "sufficient_sample": {
            "title": "Sufficient Sample",
            "type": "boolean"
          }
        },
        "required": [
          "sufficient_sample"
        ],
        "title": "PayerHealthWindow",
        "type": "object"
      },
      "PayerHealthWindows": {
        "properties": {
          "last_day": {
            "$ref": "#/components/schemas/PayerHealthWindow"
          },
          "last_hour": {
            "$ref": "#/components/schemas/PayerHealthWindow"
          }
        },
        "required": [
          "last_hour",
          "last_day"
        ],
        "title": "PayerHealthWindows",
        "type": "object"
      },
      "PayerPage": {
        "description": "``GET /v1/payers``: one page of payer records.",
        "properties": {
          "nextPageToken": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Nextpagetoken"
          },
          "payers": {
            "items": {
              "$ref": "#/components/schemas/PayerRecord"
            },
            "title": "Payers",
            "type": "array"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "payers"
        ],
        "title": "PayerPage",
        "type": "object"
      },
      "PayerRecord": {
        "description": "The Claim House JSON payer record. ``payerId`` is the immutable internal\nid (use it as a database key); ``primaryPayerId`` is what to show and what\n``tradingPartnerServiceId`` usually carries; ``aliases`` also resolve. The\nsnake_case fields say what a customer can do with the payer through Claim\nHouse today.",
        "properties": {
          "accepted_searches": {
            "items": {
              "$ref": "#/components/schemas/PayerAcceptedSearch"
            },
            "title": "Accepted Searches",
            "type": "array"
          },
          "aliases": {
            "items": {
              "type": "string"
            },
            "title": "Aliases",
            "type": "array"
          },
          "attachmentDoors": {
            "items": {
              "type": "string"
            },
            "title": "Attachmentdoors",
            "type": "array"
          },
          "coverageTypes": {
            "items": {
              "type": "string"
            },
            "title": "Coveragetypes",
            "type": "array"
          },
          "displayName": {
            "title": "Displayname",
            "type": "string"
          },
          "enrollment_required": {
            "$ref": "#/components/schemas/PayerEnrollmentRequired"
          },
          "eraEnrollmentCode": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Eraenrollmentcode"
          },
          "names": {
            "items": {
              "type": "string"
            },
            "title": "Names",
            "type": "array"
          },
          "paperEobShutoff": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Papereobshutoff"
          },
          "payerId": {
            "title": "Payerid",
            "type": "string"
          },
          "primaryPayerId": {
            "title": "Primarypayerid",
            "type": "string"
          },
          "states": {
            "items": {
              "type": "string"
            },
            "title": "States",
            "type": "array"
          },
          "stats": {
            "$ref": "#/components/schemas/PayerStats"
          },
          "transactionSupport": {
            "$ref": "#/components/schemas/TransactionSupport"
          },
          "transaction_support": {
            "$ref": "#/components/schemas/PayerTransactionSupport"
          }
        },
        "required": [
          "payerId",
          "displayName",
          "primaryPayerId",
          "transactionSupport",
          "transaction_support",
          "enrollment_required",
          "stats"
        ],
        "title": "PayerRecord",
        "type": "object"
      },
      "PayerResolution": {
        "additionalProperties": true,
        "description": "How the payer named on the request was matched.",
        "properties": {
          "confidence": {
            "enum": [
              "HIGH",
              "MEDIUM"
            ],
            "title": "Confidence",
            "type": "string"
          },
          "input": {
            "additionalProperties": true,
            "description": "The payer fields the request sent that identify a payer.",
            "title": "Input",
            "type": "object"
          },
          "matched_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Matched Name"
          },
          "matched_payer_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Matched Payer Id"
          },
          "method": {
            "description": "EXACT: the payer ID itself. ALIAS: another ID or the exact name. CONFIRMED: a person confirmed the match. LEARNED: an earlier payer answer for this input confirmed it.",
            "enum": [
              "EXACT",
              "ALIAS",
              "CONFIRMED",
              "LEARNED"
            ],
            "title": "Method",
            "type": "string"
          }
        },
        "required": [
          "input",
          "matched_payer_id",
          "matched_name",
          "method",
          "confidence"
        ],
        "title": "PayerResolution",
        "type": "object"
      },
      "PayerSearchResults": {
        "additionalProperties": true,
        "description": "``GET /v1/payers/search``: the matching payer records, best match first.",
        "properties": {
          "payers": {
            "items": {
              "$ref": "#/components/schemas/PayerRecord"
            },
            "title": "Payers",
            "type": "array"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "payers"
        ],
        "title": "PayerSearchResults",
        "type": "object"
      },
      "PayerStats": {
        "description": "Last 30 days of Claim House production eligibility checks to this payer,\nacross all customers, rounded. Every number is null below ``minimum_sample``.",
        "properties": {
          "checks_30d": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Checks 30D"
          },
          "eligibility_answered_rate_30d": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "title": "Eligibility Answered Rate 30D"
          },
          "eligibility_median_latency_ms_30d": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Eligibility Median Latency Ms 30D"
          },
          "minimum_sample": {
            "title": "Minimum Sample",
            "type": "integer"
          }
        },
        "required": [
          "minimum_sample"
        ],
        "title": "PayerStats",
        "type": "object"
      },
      "PayerTransactionSupport": {
        "description": "Per transaction, through Claim House today. ``COMING_SOON``: the payer\ntakes it, and the Claim House product for it is not released yet.",
        "properties": {
          "attachments": {
            "enum": [
              "SUPPORTED",
              "ENROLLMENT_REQUIRED",
              "NOT_SUPPORTED",
              "COMING_SOON"
            ],
            "title": "Attachments",
            "type": "string"
          },
          "claim_status": {
            "enum": [
              "SUPPORTED",
              "ENROLLMENT_REQUIRED",
              "NOT_SUPPORTED",
              "COMING_SOON"
            ],
            "title": "Claim Status",
            "type": "string"
          },
          "claims": {
            "enum": [
              "SUPPORTED",
              "ENROLLMENT_REQUIRED",
              "NOT_SUPPORTED",
              "COMING_SOON"
            ],
            "title": "Claims",
            "type": "string"
          },
          "eligibility": {
            "enum": [
              "SUPPORTED",
              "ENROLLMENT_REQUIRED",
              "NOT_SUPPORTED",
              "COMING_SOON"
            ],
            "title": "Eligibility",
            "type": "string"
          },
          "remittance": {
            "enum": [
              "SUPPORTED",
              "ENROLLMENT_REQUIRED",
              "NOT_SUPPORTED",
              "COMING_SOON"
            ],
            "title": "Remittance",
            "type": "string"
          }
        },
        "required": [
          "eligibility",
          "claims",
          "claim_status",
          "remittance",
          "attachments"
        ],
        "title": "PayerTransactionSupport",
        "type": "object"
      },
      "ReachableFacility": {
        "description": "One office the caller can reach, with its name.",
        "properties": {
          "city": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "City"
          },
          "code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The office code (control prefix).",
            "title": "Code"
          },
          "facility_id": {
            "title": "Facility Id",
            "type": "string"
          },
          "mode": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The office's binding: sandbox (test) or production (live).",
            "title": "Mode"
          },
          "name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Display name, else legal name, else the office code.",
            "title": "Name"
          },
          "state": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "State"
          }
        },
        "required": [
          "facility_id",
          "name",
          "code",
          "city",
          "state",
          "mode"
        ],
        "title": "ReachableFacility",
        "type": "object"
      },
      "ReasonVersionBody": {
        "properties": {
          "expected_version": {
            "minimum": 1.0,
            "title": "Expected Version",
            "type": "integer"
          },
          "reason": {
            "maxLength": 1000,
            "minLength": 1,
            "title": "Reason",
            "type": "string"
          }
        },
        "required": [
          "expected_version",
          "reason"
        ],
        "title": "ReasonVersionBody",
        "type": "object"
      },
      "RequestCorrection": {
        "description": "One normalization Claim House applied to the request. A\nperson's value is never repeated: a date names its formats, and trimmed\ntext says so.",
        "properties": {
          "field": {
            "description": "The request field, for example subscriber.dateOfBirth.",
            "title": "Field",
            "type": "string"
          },
          "from": {
            "description": "What arrived: a date format, or the value when not a person's.",
            "title": "From",
            "type": "string"
          },
          "to": {
            "description": "What was sent.",
            "title": "To",
            "type": "string"
          }
        },
        "required": [
          "field",
          "from",
          "to"
        ],
        "title": "RequestCorrection",
        "type": "object"
      },
      "RetryPayerUnavailable": {
        "description": "Opt in: payer-down rows are checked again later, as new checks.",
        "properties": {
          "hours": {
            "description": "1 to 24. Rows that end 502 PAYER_UNAVAILABLE are checked again 1, 4 and 12 hours after their first check, for each of those that falls within this many hours. Each try is a new check with its own key; payer-down checks are free.",
            "maximum": 24.0,
            "minimum": 1.0,
            "title": "Hours",
            "type": "integer"
          }
        },
        "required": [
          "hours"
        ],
        "title": "RetryPayerUnavailable",
        "type": "object"
      },
      "TransactionSupport": {
        "properties": {
          "claimPayment": {
            "enum": [
              "SUPPORTED",
              "ENROLLMENT_REQUIRED",
              "NOT_SUPPORTED"
            ],
            "title": "Claimpayment",
            "type": "string"
          },
          "claimStatus": {
            "enum": [
              "SUPPORTED",
              "ENROLLMENT_REQUIRED",
              "NOT_SUPPORTED"
            ],
            "title": "Claimstatus",
            "type": "string"
          },
          "dentalClaimSubmission": {
            "enum": [
              "SUPPORTED",
              "ENROLLMENT_REQUIRED",
              "NOT_SUPPORTED"
            ],
            "title": "Dentalclaimsubmission",
            "type": "string"
          },
          "eligibilityCheck": {
            "enum": [
              "SUPPORTED",
              "ENROLLMENT_REQUIRED",
              "NOT_SUPPORTED"
            ],
            "title": "Eligibilitycheck",
            "type": "string"
          },
          "unsolicitedClaimAttachment": {
            "enum": [
              "SUPPORTED",
              "ENROLLMENT_REQUIRED",
              "NOT_SUPPORTED"
            ],
            "title": "Unsolicitedclaimattachment",
            "type": "string"
          }
        },
        "required": [
          "eligibilityCheck",
          "claimStatus",
          "dentalClaimSubmission",
          "claimPayment",
          "unsolicitedClaimAttachment"
        ],
        "title": "TransactionSupport",
        "type": "object"
      },
      "UsageBilling": {
        "additionalProperties": true,
        "properties": {
          "products": {
            "items": {
              "$ref": "#/components/schemas/UsageProduct"
            },
            "title": "Products",
            "type": "array"
          },
          "statements": {
            "items": {
              "$ref": "#/components/schemas/UsageStatement"
            },
            "title": "Statements",
            "type": "array"
          }
        },
        "required": [
          "products",
          "statements"
        ],
        "title": "UsageBilling",
        "type": "object"
      },
      "UsageBody": {
        "additionalProperties": true,
        "properties": {
          "billing": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/UsageBilling"
              },
              {
                "type": "null"
              }
            ]
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "seller_id": {
            "title": "Seller Id",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "seller_id"
        ],
        "title": "UsageBody",
        "type": "object"
      },
      "UsageProduct": {
        "additionalProperties": true,
        "properties": {
          "by_reason": {
            "description": "Every unit of the month by reason and state: charged, under review and free.",
            "items": {
              "$ref": "#/components/schemas/UsageReasonCount"
            },
            "title": "By Reason",
            "type": "array"
          },
          "product": {
            "title": "Product",
            "type": "string"
          },
          "tiers": {
            "items": {
              "$ref": "#/components/schemas/UsageTierBand"
            },
            "title": "Tiers",
            "type": "array"
          },
          "units": {
            "title": "Units",
            "type": "integer"
          }
        },
        "required": [
          "product",
          "units",
          "by_reason",
          "tiers"
        ],
        "title": "UsageProduct",
        "type": "object"
      },
      "UsageReasonCount": {
        "properties": {
          "label": {
            "title": "Label",
            "type": "string"
          },
          "reason": {
            "title": "Reason",
            "type": "string"
          },
          "state": {
            "enum": [
              "BILLABLE",
              "PENDING",
              "NOT_BILLABLE"
            ],
            "title": "State",
            "type": "string"
          },
          "units": {
            "title": "Units",
            "type": "integer"
          }
        },
        "required": [
          "reason",
          "state",
          "units",
          "label"
        ],
        "title": "UsageReasonCount",
        "type": "object"
      },
      "UsageStatement": {
        "additionalProperties": true,
        "properties": {
          "lines": {
            "items": {
              "$ref": "#/components/schemas/UsageStatementLine"
            },
            "title": "Lines",
            "type": "array"
          },
          "period": {
            "format": "date",
            "title": "Period",
            "type": "string"
          },
          "statement_id": {
            "title": "Statement Id",
            "type": "string"
          },
          "status": {
            "enum": [
              "DRAFT",
              "FINAL"
            ],
            "title": "Status",
            "type": "string"
          },
          "total_micros": {
            "title": "Total Micros",
            "type": "integer"
          }
        },
        "required": [
          "statement_id",
          "period",
          "status",
          "total_micros",
          "lines"
        ],
        "title": "UsageStatement",
        "type": "object"
      },
      "UsageStatementLine": {
        "properties": {
          "amount_micros": {
            "title": "Amount Micros",
            "type": "integer"
          },
          "from_units": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "From Units"
          },
          "kind": {
            "enum": [
              "PRODUCT_TIER",
              "MINIMUM"
            ],
            "title": "Kind",
            "type": "string"
          },
          "product": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Product"
          },
          "tier": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Tier"
          },
          "to_units": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Null for the open top tier.",
            "title": "To Units"
          },
          "unit_price_micros": {
            "title": "Unit Price Micros",
            "type": "integer"
          },
          "units": {
            "title": "Units",
            "type": "integer"
          }
        },
        "required": [
          "tier",
          "from_units",
          "to_units",
          "units",
          "unit_price_micros",
          "amount_micros",
          "kind",
          "product"
        ],
        "title": "UsageStatementLine",
        "type": "object"
      },
      "UsageTierBand": {
        "description": "The month's units in one price tier: \"Units 251 to 3,500 at $0.15\".",
        "properties": {
          "amount_micros": {
            "title": "Amount Micros",
            "type": "integer"
          },
          "from_units": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "From Units"
          },
          "tier": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Tier"
          },
          "to_units": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Null for the open top tier.",
            "title": "To Units"
          },
          "unit_price_micros": {
            "title": "Unit Price Micros",
            "type": "integer"
          },
          "units": {
            "title": "Units",
            "type": "integer"
          }
        },
        "required": [
          "tier",
          "from_units",
          "to_units",
          "units",
          "unit_price_micros",
          "amount_micros"
        ],
        "title": "UsageTierBand",
        "type": "object"
      },
      "UsageUnit": {
        "properties": {
          "actor": {
            "$ref": "#/components/schemas/UsageUnitActor"
          },
          "billing_period": {
            "description": "The first day of the month the unit is billed in.",
            "format": "date",
            "title": "Billing Period",
            "type": "string"
          },
          "channel": {
            "anyOf": [
              {
                "enum": [
                  "api",
                  "dashboard",
                  "agent",
                  "batch",
                  "system"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Channel"
          },
          "facility_id": {
            "title": "Facility Id",
            "type": "string"
          },
          "label": {
            "title": "Label",
            "type": "string"
          },
          "occurred_at": {
            "format": "date-time",
            "title": "Occurred At",
            "type": "string"
          },
          "product": {
            "title": "Product",
            "type": "string"
          },
          "reason": {
            "title": "Reason",
            "type": "string"
          },
          "source_id": {
            "description": "The eligibility id of the check (for a saved answer, the check served).",
            "title": "Source Id",
            "type": "string"
          },
          "state": {
            "enum": [
              "BILLABLE",
              "PENDING",
              "NOT_BILLABLE"
            ],
            "title": "State",
            "type": "string"
          },
          "usage_id": {
            "title": "Usage Id",
            "type": "integer"
          }
        },
        "required": [
          "usage_id",
          "occurred_at",
          "facility_id",
          "product",
          "state",
          "reason",
          "label",
          "billing_period",
          "source_id",
          "channel",
          "actor"
        ],
        "title": "UsageUnit",
        "type": "object"
      },
      "UsageUnitActor": {
        "properties": {
          "id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The API key id, or the dashboard member's id. Null for Claim House staff.",
            "title": "Id"
          },
          "kind": {
            "anyOf": [
              {
                "enum": [
                  "api_key",
                  "member",
                  "operator",
                  "system"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Kind"
          },
          "name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The API key's name. Null for a dashboard member.",
            "title": "Name"
          }
        },
        "required": [
          "kind",
          "id",
          "name"
        ],
        "title": "UsageUnitActor",
        "type": "object"
      },
      "UsageUnitsPage": {
        "properties": {
          "data": {
            "items": {
              "$ref": "#/components/schemas/UsageUnit"
            },
            "title": "Data",
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Pass as cursor for the next page; null on the last page.",
            "title": "Next Cursor"
          },
          "period": {
            "description": "YYYY-MM",
            "title": "Period",
            "type": "string"
          },
          "request_id": {
            "title": "Request Id",
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "description": "True for a live key, false for a test key."
          }
        },
        "required": [
          "request_id",
          "period",
          "data",
          "next_cursor"
        ],
        "title": "UsageUnitsPage",
        "type": "object"
      }
    },
    "responses": {
      "Error": {
        "description": "Refused. The body names the code, whether to retry and what to do next.",
        "headers": {
          "X-Request-Id": {
            "description": "This request's id.",
            "schema": {
              "type": "string"
            }
          },
          "Retry-After": {
            "description": "Seconds to wait before resending, when known.",
            "schema": {
              "type": "integer"
            }
          },
          "Claim-House-Version": {
            "description": "The API version this response was served under.",
            "schema": {
              "type": "string"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "apiKey": {
        "type": "http",
        "scheme": "bearer",
        "description": "Your API key: `Authorization: Bearer <key>`. A test key (`ch_test_`) reaches test offices only and never a payer; a live key reaches live offices."
      }
    }
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    {
      "name": "activity",
      "description": "Your organization's API request log and access requests."
    },
    {
      "name": "artifacts",
      "description": "Stored files, such as eligibility PDFs, read by a short-lived link."
    },
    {
      "name": "auth",
      "description": "Who the key or session is, and what it may do."
    },
    {
      "name": "billing",
      "description": "The card on file and the billing portal."
    },
    {
      "name": "eligibility",
      "description": "Check a patient's dental coverage with the eligibility vendor, store the answer, and render it as a PDF."
    },
    {
      "name": "facilities",
      "description": "The offices you check for: list, add, import and take live."
    },
    {
      "name": "keys",
      "description": "API keys: list, make and revoke."
    },
    {
      "name": "members",
      "description": "The people in your organization and their invitations."
    },
    {
      "name": "payers",
      "description": "Look up which payers Claim House knows, which transactions each supports, and which attachment doors each accepts."
    },
    {
      "name": "test mode",
      "description": "Sample patients and magic member IDs for test mode. Nothing reaches a payer."
    },
    {
      "name": "usage",
      "description": "Read meter counts for your seller account over a date range."
    }
  ]
}
