OIG Exclusion

Create OIG exclusion check

Submits one organization-scoped provider OIG screening request and returns the sanitized local check result. The runtime can return an existing recent matching check instead of creating a new row or performing a fresh federal-source lookup.

POSTPublic reference baselineExternal or credentialedOIG ExclusionoperationId: createOigExclusionCheckhttps://dev-api.quickintell.com/api/v1/oig-exclusion/checks

Public reference baselineExternal or credentialedProvider 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. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.

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

External or credentialed

May touch credentials, webhooks, SFTP, EHRs, payers, portals, clearinghouses, or other external systems.

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 POST /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 POST /api/v1/oig-exclusion/checks contract as a external or credentialed baseline endpoint.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Mutating behavior still needs side-effect and retry evidence.

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	No idempotency mechanism is declared.	Do not retry blindly. Check resource, status, batch, or job state before repeating the request.
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.

Publication warnings

Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.
External or credentialed behavior needs vendor trust, credential, webhook, and callback evidence before publication.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes Idempotency

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 when a provider record needs an on-demand exclusion check before credentialing, onboarding, claim release, or compliance review.

Before calling

Authenticate with a tenant-scoped bearer API key that has `oig-exclusion:write` scope. Collect the provider's legal display name, 10-digit NPI, and two-uppercase-letter state code from trusted organization or credentialing data. If you send `userId` or `providerId`, confirm those IDs belong to the authenticated organization before calling.

Request and response behavior

Request guidance

`entityName`, `checkType`, `npi`, and `state` are required. The public request schema currently accepts `checkType: PROVIDER` only. `npi` must match exactly 10 digits. `state` is validated only as two uppercase letters; the public schema does not prove the value is a real state or licensing jurisdiction. Optional `userId` and `providerId` are validated before screening: `userId` must match an active `OrganizationMember` in the authenticated organization, and `providerId` must match a non-deleted `CredentialingSession` in the authenticated organization.

`entityName` must be 2 to 200 characters. Prefer legal provider names over nicknames or email addresses.
`checkType` is constrained to `PROVIDER` in the public create schema even though response records can represent additional check types created by other workflows.
`userId` is accepted only when it resolves to an active `OrganizationMember` for the authenticated organization; otherwise the endpoint returns 404 before screening.
`providerId` is accepted only when it resolves to a non-deleted `CredentialingSession` for the authenticated organization; otherwise the endpoint returns 404 before screening.
Do not include date of birth, Social Security numbers, source-list records, credentials, or raw vendor payloads in this request.

Response semantics

A successful 201 response returns `data.check` and `meta.organizationId`. The returned check can be newly created or an existing recent deduplicated check for the same organization, entity name, and NPI. The check contains local status, structured match summary, optional structured LEIE/SAM details, and review timestamps when present.

`status` is the local QuickRCM check status after screening or deduplicated lookup.
`matchSummary` is a structured summary and may be null when no scoring detail is available; do not document it as a raw LEIE or SAM.gov payload.
`leie` and `sam` contain structured metadata fields such as exclusion type/date, not raw source payloads.
`reviewedBy` and `reviewedAt` can be null until a human resolution is recorded.
`data.check.organizationId` and `meta.organizationId` should match the authenticated bearer credential's organization.
A 201 status should be documented as the public endpoint's success status, not as proof that a new database row or fresh LEIE/SAM lookup happened.

Errors and retries

Correct validation errors before retrying. 404 can mean an optional linked `userId` or `providerId` was missing from the authenticated organization or was not eligible for linking. If a client times out after submission, list recent checks or search by entity name before creating another check to avoid duplicate local records.

400 can indicate a missing required field, invalid NPI pattern, invalid state-code pattern, or unsupported check type.
404 can indicate a linked `userId` or `providerId` was not found in the authenticated organization under the required active/non-deleted filters.
401/403 require credential, scope, permission, or tenant-context correction.
429 should be retried with backoff.

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

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.

Name	Location	Required	Type	Description	Validation and safety notes
entityName	body	Yes	string	Screened provider name, 2 to 200 characters. Prefer legal names and avoid email-only names.	Minimum length: 2. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values.
checkType	body	Yes	PROVIDER	Manual public check type. The public create schema currently allows only `PROVIDER`.	Enum values are declared in the Type column.
npi	body	Yes	string	Provider National Provider Identifier value. The public schema enforces exactly 10 digits.	Pattern constraint declared in OpenAPI.
state	body	Yes	string	Two-uppercase-letter state code used as screening context. The schema enforces the pattern, not jurisdiction validity.	Pattern constraint declared in OpenAPI.
userId	body	No	string	Optional QuickRCM user identifier. It must resolve to an active organization member in the authenticated organization.	Minimum length: 1. Potential PHI; use synthetic examples and avoid logging raw values.
providerId	body	No	string	Optional QuickRCM credentialing-session/provider link. It must resolve to a non-deleted credentialing session in the authenticated organization.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.

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.

{
  "entityName": "Dr. Avery Smith",
  "checkType": "PROVIDER",
  "npi": "1234567893",
  "state": "CA",
  "userId": "00000000-0000-4000-8000-000000000001",
  "providerId": "00000000-0000-4000-8000-000000000001"
}

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.

201

Created OIG exclusion check result.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "check": {
      "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"
    }
  },
  "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.