Insurance Discovery

List insurance discovery searches

Lists local insurance discovery search records owned by the organization selected by the bearer API key.

GETPublic reference baselineRead-onlyInsurance DiscoveryoperationId: listInsuranceDiscoverySearcheshttps://dev-api.quickintell.com/api/v1/insurance-discovery/searches

Public reference baselineRead-onlyEligibility and discovery

Route status

Public reference baseline

Generated endpoint contract may be shown with caveats, but external publication still needs route registry and release evidence.

Publication status

Baseline reference only

Requires E6 route registry and E9 release evidence before external publication.

Authentication

Bearer API key declared

OpenAPI declares bearer API-key security for this operation.

Tenant context

API-key organization

API-key organization context is authoritative; request organizationId is not a public tenant selector.

Side-effect summary

Read-only

Reads tenant-scoped data only unless the endpoint description explicitly states an external lookup.

Source artifact

docs/openapi/openapi.json

OpenAPI 3.1.0; API 1.0.0.

When to use this endpoint

Use this page as an internal baseline for the eligibility and discovery contract generated for GET /api/v1/insurance-discovery/searches. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated GET /api/v1/insurance-discovery/searches contract as a read-only baseline endpoint.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Read behavior still needs release evidence before broad external publication.

Not public from this page

Live external side effects, file contents, credentials, webhooks, SDK promises, and production recipes are still gated.

Headers and tenancy

Current headers and tenant authority. Target headers stay labeled as future until OpenAPI and release evidence declare them.

Header	Required	Current status	Notes
Authorization	Yes	Current	Bearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-Key	No	Target/future	Do not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-Id	No	Target/future	Use for support correlation only after approved; not declared as a standard OpenAPI header today.

Required scopes

Unclassified until E6 route metadata exists; do not infer scopes from route names.

Wrong-org behavior

Tenant-safe 404, empty list, or 403 is endpoint-specific and remains an evidence gap until E1 is closed.

Actor and audit

No public actor, audit, or correlation contract is published from OpenAPI alone.

Idempotency and retries

Retry behavior is documented conservatively because universal idempotency headers are not declared.

Topic	Status	Guidance
Current idempotency	Read request; no mutation idempotency contract needed.	Use ordinary safe-read retry behavior with rate-limit backoff.
Universal header	Not declared	Do not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behavior	Unresolved	Same-key changed-payload, in-flight retry, fingerprint scope, and TTL behavior remain endpoint-specific evidence gaps.

Async jobs and polling

Queued work is accepted work, not proof of completed workflow execution.

Topic	Status	Guidance
Immediate response	No 202 response declared	OpenAPI does not declare HTTP 202 for this operation.
Polling and terminal states	Not indicated by OpenAPI	No generic polling contract is published from this page.
Later side effects	Not proven	Do not infer background execution beyond the documented response.

Files and artifacts

File-like routes need content-class, ownership, scanning, retention, and URL policy evidence before public recipes.

Topic	Status	Guidance
Content class	No file/artifact class inferred	OpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keys	Not applicable unless a file field is present	Tenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retention	Unresolved unless endpoint-specific evidence exists	Short-lived URLs, MIME limits, checksums, scanner status, retention, expiration, and legal hold behavior are not implied by OpenAPI examples.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Public reference baseline from documentation classification overlay.	E6 route registry evidence is still required before external publication.
Example validation	Generated examples are internal baseline aids.	No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewed	Implementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.	Refresh this evidence for release workspaces.
Release evidence	E9 required.	No SDK readiness, production readiness, or expanded external docs claim from this endpoint page.

Insurance Discovery public API.

Insurance Discovery APIs expose organization-scoped workflows for finding possible hidden coverage for self-pay or uninsured patients, reviewing local discovery search records, starting simulated batch discovery, retrying failed searches in simulated mode, and verifying or dismissing discovered coverage. The bearer API key selects the organization. Public request bodies should not be documented as tenant selectors, and `organizationId` in responses is ownership/context metadata rather than a caller-controlled organization switch. Patient, search, and batch identifiers must resolve inside the authenticated organization. Search inputs can include patient demographics and optional sensitive matching fields. Treat names, dates of birth, addresses, ZIP codes, Social Security number (SSN) last four digits, payer member IDs, discovered group IDs, and match details as Protected Health Information (PHI) or sensitive insurance data where applicable. Examples must stay synthetic, and public docs should discourage logging search terms, raw vendor payloads, Electronic Health Record (EHR) responses, credentials, tokens, storage keys, and payer portal data. The public surface has mixed side-effect profiles. List and get endpoints read local QuickRCM Revenue Cycle Management (RCM) discovery records. `verifyDiscoveredCoverage` performs local database updates and is documented with `SAFE_WRITE_DB_ONLY` metadata. `startInsuranceDiscoveryBatch` and `retryInsuranceDiscoverySearch` require `simulateOnly: true` and return `SIMULATED_ONLY` metadata because those workflows can consume credits and call the simulated discovery vendor. Retry requests do not accept replacement demographics; current retry behavior reuses the failed search's stored first name, last name, date of birth, address, and ZIP code while not resubmitting stored SSN last-four. `runInsuranceDiscoverySearch` has no public `simulateOnly` flag; it can create a local PHI-bearing search record, consume discovery credits, and potentially transmit patient demographics to a discovery vendor, so document it with credit and privacy warnings. Verification should be described as a local QuickRCM coverage/account state update, not payer adjudication, eligibility verification, claim readiness, or EHR insurance write-back. Existing module docs state that direct EHR write-back is not wired from Insurance Discovery. Current public verification evidence supports creating a new local `PatientInsurance` record when discovered member data is available and storing that new identifier on the search; otherwise `patientInsuranceId` remains null. Downstream eligibility re-verification, claim use, payer configuration resolution, and optional EHR synchronization require separate workflows.

What this endpoint does

Use case

Use this endpoint to build discovery worklists, review recent search outcomes, find searches by patient or batch, or page through local discovery history before verifying, dismissing, or retrying a specific search.

Before calling

Authenticate with an API key authorized for Insurance Discovery reads. Choose narrow filters where possible: `status`, `batchId`, `patientId`, `searchTerm`, `skip`, and `take`.

Request and response behavior

Request guidance

`status`, `batchId`, `patientId`, and `searchTerm` are optional filters. `searchTerm` is trimmed, must be 1 to 200 characters when supplied, and can match patient or payer context, so avoid logging it. `skip` defaults to 0 and must be an integer from 0 through 10000. `take` defaults to 25 and must be an integer from 1 through 100. Do not send `organizationId`; the API key selects the tenant.

`status` accepts `DISC_PENDING`, `DISC_SEARCHING`, `DISC_FOUND`, `DISC_NOT_FOUND`, `DISC_VERIFIED`, `DISC_FAILED`, `DISC_EXPIRED`, and `DISC_DISMISSED`.
Use `patientId` or `batchId` when reconciling a known workflow to avoid broad exports.
Read endpoints accept either `insurance-discovery:read` or `insurance-discovery:write` scope according to the public API handler.

Response semantics

HTTP 200 returns `data.searches`, `total`, `skip`, `take`, and `meta.organizationId`. Search rows are local QuickRCM records with status, trigger, optional source, optional found coverage summary, lifecycle timestamps, and local linkage identifiers. `meta.organizationId` is response context, not a request-time tenant selector.

`foundCoverage` is a local discovery result summary; it is not eligibility verification or payer acceptance.
`patientInsuranceId` is populated only after verified coverage is linked locally.
Use `getInsuranceDiscoverySearch` for one search before state-changing actions.

Errors and retries

Treat 400 as invalid filters or pagination bounds, 401 as missing or invalid credentials, 403 as tenant, scope, or permission failure, and 429 as a backoff signal. Retry transient 5xx responses with bounded backoff.

400 can indicate an invalid status enum, negative skip, excessive skip, invalid take, or overlong search term.
403 means the key cannot read Insurance Discovery for the selected tenant.
429 should be retried with backoff rather than tight polling.

Template boundary before examples

The route class, authentication state, tenancy rule, side-effect mode, idempotency status, async behavior, file policy, warnings, links, and evidence above are part of the endpoint contract. Treat generated examples below as internal baseline aids until release evidence closes.

Path parameters

This endpoint does not define path parameters.

Query parameters

Name	Location	Required	Type	Description	Validation and safety notes
status	query	No	DISC_PENDING \| DISC_SEARCHING \| DISC_FOUND \| DISC_NOT_FOUND \| DISC_VERIFIED \| DISC_FAILED \| DISC_EXPIRED \| DISC_DISMISSED	Optional local discovery workflow status filter.	Enum values are declared in the Type column.
batchId	query	No	string	Optional non-empty batch identifier filter. The batch must belong to the API key organization.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
patientId	query	No	string	Optional non-empty QuickRCM patient identifier filter. The patient must belong to the API key organization.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
searchTerm	query	No	string	Optional text filter, trimmed and capped at 200 characters. Avoid logging raw values because they can include patient or payer context.	Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values.
skip	query	No	integer	Zero-based number of search rows to skip. Defaults to 0 and cannot exceed 10000.	Minimum value: 0. Maximum value: 10000. Default: 0.
take	query	No	integer	Maximum search rows to return. Defaults to 25 and cannot exceed 100.	Minimum value: 1. Maximum value: 100. Default: 25.

OpenAPI-declared header parameters

Standard platform header guidance appears in the governance panel. This table only lists operation-specific headers declared in OpenAPI.

This endpoint does not define operation-specific header parameters.

Request body

JSON fields from the generated OpenAPI schema with pilot enrichment applied where available. Nested object fields are shown with dotted paths.

This endpoint does not define a JSON request body.

Generated request example

Generated examples are baseline contract aids only. They are not external publication evidence and must not include real PHI, credentials, raw vendor payloads, raw EDI, transcripts, storage keys, or signed URLs.

No request example is declared.

Successful responses

Generated response examples show the baseline OpenAPI contract. Tenant identifier echo, PHI redaction, pagination, money, date/time, and enum semantics remain endpoint-specific publication checks.

200

Discovery searches for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "searches": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "organizationId": "00000000-0000-4000-8000-000000000001",
        "patientId": "00000000-0000-4000-8000-000000000001",
        "batchId": "00000000-0000-4000-8000-000000000001",
        "status": "DISC_PENDING",
        "source": "DISC_SRC_EXPERIAN",
        "trigger": "DISC_TRIG_REGISTRATION",
        "foundCoverage": {
          "payerName": "Example insurance_discovery_searche",
          "memberId": "W123456789",
          "groupId": "00000000-0000-4000-8000-000000000001",
          "planType": "example-plantype",
          "coverageStart": "2026-06-08T10:15:30Z",
          "coverageEnd": "2026-06-08T10:15:30Z",
          "matchScore": "example-matchscore"
        },
        "eligibilityCheckId": "00000000-0000-4000-8000-000000000001",
        "patientInsuranceId": "00000000-0000-4000-8000-000000000001",
        "verifiedAt": "2026-06-08T10:15:30Z",
        "dismissedAt": "2026-06-08T10:15:30Z",
        "dismissReason": "example-dismissreason",
        "searchStartedAt": "2026-06-08T10:15:30Z",
        "searchCompletedAt": "2026-06-08T10:15:30Z",
        "createdAt": "2026-06-08T10:15:30Z",
        "updatedAt": "2026-06-08T10:15:30Z"
      }
    ],
    "total": 1,
    "skip": 1,
    "take": 1
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

Error responses

Errors must remain sanitized. Do not include raw payer, EHR, SFTP, SMTP, Stripe, LLM/OCR, browser automation, file, transcript, EDI, worker, or vendor payloads.

400

Invalid request.