OIG Exclusion

List OIG exclusion checks

Returns a paginated list of OIG exclusion checks owned by the organization selected by the bearer API key, with optional filters for local status, checked-at date bounds, entity-name search text, and sort order.

GETPublic reference baselineRead-onlyOIG ExclusionoperationId: listOigExclusionCheckshttps://dev-api.quickintell.com/api/v1/oig-exclusion/checks

Public reference baselineRead-onlyProvider and payer setup

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 provider and payer setup contract generated for GET /api/v1/oig-exclusion/checks. 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/oig-exclusion/checks 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	Endpoint-specific	Use only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
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.

OIG Exclusion public API.

OIG Exclusion APIs expose organization-scoped exclusion-check records for Office of Inspector General (OIG) screening against List of Excluded Individuals/Entities (LEIE) and System for Award Management (SAM.gov) summary data. The bearer API key selects the authenticated organization; public request bodies should not be documented as tenant selectors. The current public surface is intentionally conservative. organizationId`. The create endpoint accepts provider checks with a legal display name, `checkType: PROVIDER`, a 10-digit NPI, and a two-uppercase-letter state code; successful calls can return a recent existing check because the runtime deduplicates matching checks within the recent-check window. The bulk endpoint is dry-run only and returns `SIMULATED_ONLY` counts plus latest-run metadata without calling LEIE or SAM sources. The resolution endpoint records a human false-positive or confirmed-excluded decision for resolvable local checks, and a confirmed-excluded decision can attempt internal organization-scoped follow-up. Do not describe public responses as raw federal-source exports, external EHR write-back, payer notification, or guaranteed claim holds.

What this endpoint does

Use case

Use this endpoint to build compliance review queues, audit dashboards, provider screening history views, and follow-up lists for checks that need human review.

Before calling

Authenticate with a tenant-scoped bearer API key that has `oig-exclusion:read` or `oig-exclusion:write` scope. Choose narrow filters for compliance exports and use bounded pagination.

Request and response behavior

Request guidance

`page` defaults to 1 and is capped at 10000. `pageSize` defaults to 25 and is capped at 100. `dateFrom` and `dateTo` are ISO 8601 date or date-time strings for `checkedAt`; when both are supplied, `dateFrom` must be before or equal to `dateTo`. `search` currently filters `entityName`, not NPI, `userId`, or `providerId`.

`status` must be one of the documented `EXC_*` status values.
`search` is capped at 200 characters and is implemented as case-insensitive `entityName` contains matching.
`sortBy` supports `entityName`, `checkType`, `status`, and `checkedAt`; `sortOrder` is `asc` or `desc`.
Do not send `organizationId`; tenant selection comes from the bearer API key and is echoed in response metadata.

Response semantics

A 200 response returns `data.checks`, `total`, `page`, `pageSize`, and `meta.organizationId`. Each check row contains local record identifiers, check type, entity name, optional NPI/user/provider links, status, structured match summaries, structured LEIE/SAM metadata, review metadata, and `checkedAt`.

`data.checks` reflects local QuickRCM exclusion-check records, not proof of a current federal source-list lookup.
`matchSummary`, `leie`, and `sam` are structured summaries; the public schema does not expose raw LEIE rows or raw SAM.gov responses.
`reviewNotes` is intentionally omitted from the public check serializer; only reviewer identity and timestamp fields are returned.
`checkedAt` is the server timestamp for when the local check was performed or recorded; it is not a caller-supplied source-list timestamp.
`checks[].organizationId` and `meta.organizationId` should be treated as authenticated-tenant echoes, not request routing inputs.
Use `getOigExclusionCheck` for a single check by id.

Errors and retries

Treat 400 as invalid filters, pagination, date bounds, status, or sort values. Treat 401/403 as credential, scope, or tenant-authorization issues. Back off on 429 and retry transient 5xx responses within normal client retry limits.

400 can indicate invalid status, date ordering, page, pageSize, sortBy, or sortOrder.
403 means the authenticated caller cannot access the organization context or lacks an accepted scope.
429 should be handled with client backoff rather than tight compliance 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	EXC_CLEAR \| EXC_MATCH_FOUND \| EXC_REVIEW_NEEDED \| EXC_FALSE_POSITIVE \| EXC_CONFIRMED_EXCLUDED \| EXC_ERROR	Optional filter for the local exclusion-check lifecycle status: `EXC_CLEAR`, `EXC_MATCH_FOUND`, `EXC_REVIEW_NEEDED`, `EXC_FALSE_POSITIVE`, `EXC_CONFIRMED_EXCLUDED`, or `EXC_ERROR`.	Enum values are declared in the Type column.
page	query	No	integer	One-based page number. Defaults to 1 and cannot exceed 10000.	Minimum value: 1. Maximum value: 10000. Default: 1.
pageSize	query	No	integer	Maximum number of checks to return. Defaults to 25 and cannot exceed 100.	Minimum value: 1. Maximum value: 100. Default: 25.
dateFrom	query	No	string	Inclusive ISO 8601 lower bound for `checkedAt`.	Minimum length: 1.
dateTo	query	No	string	Inclusive ISO 8601 upper bound for `checkedAt`. Must be after or equal to `dateFrom` when both are provided.	Minimum length: 1.
search	query	No	string	Optional free-text filter capped at 200 characters. Runtime search is by `entityName` only.	Minimum length: 1. Maximum length: 200.
sortBy	query	No	entityName \| checkType \| status \| checkedAt	Optional sort field: `entityName`, `checkType`, `status`, or `checkedAt`.	Enum values are declared in the Type column.
sortOrder	query	No	asc \| desc	Optional sort direction: `asc` or `desc`.	Enum values are declared in the Type column.

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

OIG exclusion checks for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "checks": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "organizationId": "00000000-0000-4000-8000-000000000001",
        "checkType": "PROVIDER",
        "entityName": "Example oig_exclusion_check",
        "npi": "1234567893",
        "userId": "00000000-0000-4000-8000-000000000001",
        "providerId": "00000000-0000-4000-8000-000000000001",
        "status": "EXC_CLEAR",
        "matchSummary": {
          "leieMatch": true,
          "samMatch": true,
          "matchScore": 1.25
        },
        "leie": {
          "exclusionType": "example-exclusiontype",
          "exclusionDate": "2026-06-08T10:15:30Z",
          "reinstatementDate": "2026-06-08T10:15:30Z",
          "state": "example-state",
          "specialty": "example-specialty"
        },
        "sam": {
          "exclusionType": "example-exclusiontype",
          "exclusionDate": "2026-06-08T10:15:30Z"
        },
        "reviewedBy": "example-reviewedby",
        "reviewedAt": "2026-06-08T10:15:30Z",
        "checkedAt": "2026-06-08T10:15:30Z"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 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.