QuickRCM API Docs

Enhanced claim status

Get restricted raw response history

Requires claim-status:raw scope.

GETNeeds publication reviewRead-onlyEnhanced claim statusoperationId: getEnhancedStatusRawApihttps://dev-api.quickintell.com/api/v1/claim-status/inquiries/{id}/raw
Needs publication reviewRead-onlyUnclassified

Route status

Needs publication review

The endpoint contract is visible, but QuickRCM has not approved it yet for normal production API use.

Publication status

Needs publication review

Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.

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 unclassified contract generated for GET /api/v1/claim-status/inquiries/{id}/raw. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Shows the generated OpenAPI shape for GET /api/v1/claim-status/inquiries/{id}/raw, but keeps the route out of ordinary production API positioning until review is complete.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior.

Not public from this page

Do not publish this endpoint as an ordinary developer API until its unresolved decisions are closed.

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 statesEndpoint-specificUse only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
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.

Publication warnings

  • This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.

Related platform rules

Workflow GuideRoute StatusTenant ContextErrorsRate LimitsPHI and SecurityPublication Readiness

Evidence

EvidenceStatusCaveat
OpenAPI artifactdocs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.Generated baseline contract only.
Route registryNeeds publication review 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.

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
idpathYesstringIdentifier from the nested payer, submitter, provider, or product object. Interpret it within that object's context, not globally.OpenAPI does not declare additional validation metadata.

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
Raw exchange history (up to 250 records), ordered oldest first.
Generated from the OpenAPI response schema.
{
  "inquiryId": "00000000-0000-4000-8000-000000000001",
  "exchanges": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "payerId": "87726",
      "transactionId": "00000000-0000-4000-8000-000000000001",
      "method": "example-method",
      "status": 1,
      "body": "example-body",
      "bodyHash": "example-bodyhash",
      "contentType": "example-contenttype",
      "retryAfter": "example-retryafter",
      "errorCode": "example-errorcode",
      "createdAt": "2026-06-08T10:15:30Z",
      "receivedAt": "2026-06-08T10:15:30Z"
    }
  ]
}

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: invalid body, query, or invalid supplied Idempotency-Key
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "INVALID_REQUEST",
      "message": "invalid body, query, or invalid supplied Idempotency-Key",
      "source": "api",
      "retryable": false
    }
  ]
}
401
AUTHENTICATION_REQUIRED: bearer key missing or invalid
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "AUTHENTICATION_REQUIRED",
      "message": "bearer key missing or invalid",
      "source": "api",
      "retryable": false
    }
  ]
}
403
ACCESS_DENIED: insufficient scope or access
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "ACCESS_DENIED",
      "message": "insufficient scope or access",
      "source": "api",
      "retryable": false
    }
  ]
}
404
NOT_FOUND: resource not found within this organization
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "NOT_FOUND",
      "message": "resource not found within this organization",
      "source": "api",
      "retryable": false
    }
  ]
}
409
REQUEST_CONFLICT: idempotency, mapping, or processing conflict
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "REQUEST_CONFLICT",
      "message": "idempotency, mapping, or processing conflict",
      "source": "api",
      "retryable": false
    }
  ]
}
422
REQUEST_UNPROCESSABLE: missing inputs or unpublished profile
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "REQUEST_UNPROCESSABLE",
      "message": "missing inputs or unpublished profile",
      "source": "api",
      "retryable": false
    }
  ]
}
429
RATE_LIMITED: retry later
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "RATE_LIMITED",
      "message": "retry later",
      "source": "api",
      "retryable": true
    }
  ]
}
500
INTERNAL_ERROR: sanitized server error; retry submission with the same Idempotency-Key
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "INTERNAL_ERROR",
      "message": "sanitized server error; retry submission with the same Idempotency-Key",
      "source": "api",
      "retryable": true
    }
  ]
}

Adjacent endpoints

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

GETNeeds publication reviewRead-only
Get inquiry processing state
/api/v1/claim-status/inquiries/{id}
GETNeeds publication reviewFile or artifact
Get saved canonical or mapped result
/api/v1/claim-status/inquiries/{id}/result
GETNeeds publication reviewRead-only
List organization mapping profiles
/api/v1/claim-status/profiles
POSTNeeds publication reviewLocal write
Publish immutable mapping version
/api/v1/claim-status/profiles/{id}/publish
POSTNeeds publication reviewExternal or credentialed
Replay saved responses without a payer call
/api/v1/claim-status/inquiries/{id}/reprocess
POSTNeeds publication reviewLocal write
Save mapping draft
/api/v1/claim-status/profiles
All endpoint pagesOpen Scalar reference
Get restricted raw response history | QuickRCM API Docs | QuickRCM API Docs