Insurance Discovery

Get insurance discovery search

Returns one local insurance discovery search when it belongs to the organization selected by the bearer API key.

GETPublic reference baselineRead-onlyInsurance DiscoveryoperationId: getInsuranceDiscoverySearchhttps://dev-api.quickintell.com/api/v1/insurance-discovery/searches/{searchId}
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/{searchId}. 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/{searchId} 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.

HeaderRequiredCurrent statusNotes
AuthorizationYesCurrentBearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-KeyNoTarget/futureDo not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-IdNoTarget/futureUse 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.

TopicStatusGuidance
Current idempotencyRead request; no mutation idempotency contract needed.Use ordinary safe-read retry behavior with rate-limit backoff.
Universal headerNot declaredDo not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behaviorUnresolvedSame-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.

TopicStatusGuidance
Immediate responseNo 202 response declaredOpenAPI does not declare HTTP 202 for this operation.
Polling and terminal statesNot indicated by OpenAPINo generic polling contract is published from this page.
Later side effectsNot provenDo 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.

TopicStatusGuidance
Content classNo file/artifact class inferredOpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keysNot applicable unless a file field is presentTenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retentionUnresolved unless endpoint-specific evidence existsShort-lived URLs, MIME limits, checksums, scanner status, retention, expiration, and legal hold behavior are not implied by OpenAPI examples.

Evidence

EvidenceStatusCaveat
OpenAPI artifactdocs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.Generated baseline contract only.
Route registryPublic reference baseline from documentation classification overlay.E6 route registry evidence is still required before external publication.
Example validationGenerated examples are internal baseline aids.No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewedImplementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.Refresh this evidence for release workspaces.
Release evidenceE9 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 after listing searches, creating a search, receiving a batch response, or before verify, dismiss, or retry actions that depend on the current search status.
Before calling
Use a `searchId` obtained from a trusted QuickRCM response in the same tenant. Do not guess identifiers across organizations.

Request and response behavior

Request guidance
Pass non-empty `searchId` in the path. No request body is declared. Do not include organization selectors, credentials, raw vendor payloads, or patient demographics in the request.
  • `searchId` is the only path selector.
  • The API key selects tenant context.
  • No request body is declared.
Response semantics
HTTP 200 returns the local discovery search detail and `meta.organizationId`. It can include discovered coverage summary fields, lifecycle timestamps, and local linkage identifiers. The handler looks up the search by both `id` and authenticated `organizationId`.
  • Use `status` to decide whether verify, dismiss, or retry is appropriate.
  • `foundCoverage` fields can be null even when the object is present.
  • `patientInsuranceId` is a local linkage, not proof of active payer eligibility.

Errors and retries

Treat 404 as missing or wrong-tenant search context unless a prior trusted response proves it should exist. Retry only transient 5xx or 429 responses, with backoff.
  • 404 can intentionally hide wrong-tenant searches.
  • 401 and 403 require credential or scope correction.

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

NameLocationRequiredTypeDescriptionValidation and safety notes
searchIdpathYesstringNon-empty Insurance Discovery search identifier in the path. It must belong to the API key organization.Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.

Query parameters

This endpoint does not define query parameters.

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 search detail for the authenticated organization.
Generated from the OpenAPI response schema.
{
  "success": true,
  "data": {
    "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_search",
      "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"
  },
  "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.
Handle this response as normal integration control flow.
{
  "error": "Request validation failed",
  "statusCode": 400
}
401
Authentication required or invalid credentials.
Handle this response as normal integration control flow.
{
  "error": "Authentication required",
  "statusCode": 401
}
403
The requested organization does not match the authenticated caller.
Handle this response as normal integration control flow.
{
  "error": "Forbidden",
  "statusCode": 403
}
404
Discovery search not found in the authenticated organization.
Handle this response as normal integration control flow.
{
  "error": "Resource not found",
  "statusCode": 404
}
429
API key rate limit exceeded.
Handle this response as normal integration control flow.
{
  "error": "Rate limit exceeded",
  "statusCode": 429
}
500
Internal server error.
Handle this response as normal integration control flow.
{
  "error": "Internal server error",
  "statusCode": 500
}

Adjacent endpoints

Nearby generated endpoints in the same OpenAPI tag. Route class and side-effect labels still apply per endpoint.