Credentialing

Queue credentialing document processing

Validates ownership of a local credentialing document and returns a simulated document-processing workflow response.

POSTNeeds publication reviewFile or artifactCredentialingoperationId: processCredentialingDocumenthttps://dev-api.quickintell.com/api/v1/credentialing/documents/{documentId}/process

Needs publication reviewFile or artifactProvider and payer setup

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. Also requires E2 side-effect policy, E3 async and idempotency policy, and E4 file and artifact governance 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

File or artifact

Touches documents, reports, transcripts, PDFs, EDI, or generated artifacts. Metadata is safer than raw content.

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/credentialing/documents/{documentId}/process. 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 POST /api/v1/credentialing/documents/{documentId}/process, 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. Mutating behavior still needs side-effect and retry evidence.

Not public from this page

Raw file contents, storage keys, signed URLs, and generated artifacts are not public from this page.

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	Request body exposes an endpoint-specific idempotencyKey compatibility field.	Retry only with the documented key location and after checking endpoint state; 409 behavior and retention still need release evidence.
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	202	Treat the response as accepted or queued work, not completed workflow execution.
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	Possible	Queued work may later cause local or external effects only where endpoint evidence says so.

Files and artifacts

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

Topic	Status	Guidance
Content class	Potential file or artifact	Documents, PDFs, reports, transcripts, EDI, OCR, or generated artifacts need E4 classification before public examples.
Ownership and storage keys	Evidence required	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

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.
HTTP 202 or queued behavior requires endpoint-specific polling, terminal-state, retry, and retention guidance.
Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.
File and artifact examples must stay metadata-only until scanning, retention, ownership, and URL policy are approved.

Related platform rules

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

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Needs publication review 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.

Credentialing public API.

Credentialing APIs expose organization-scoped credentialing session visibility and local workflow controls for provider credentialing packets. The public surface covers session creation and updates, provider profile fields, non-secret CAQH metadata, education, work history, licenses, professional references, liability insurance, signature file references, attestation acceptance, status updates, and safe simulated document/application workflows. The bearer API key selects the organization. Public request bodies should not be documented as tenant selectors, and every session, document, File, payer configuration, assignee, or subresource lookup is scoped to that API-key organization. List and detail reads accept `credentialing:read` or `credentialing:write`; write operations require `credentialing:write`. Several endpoints deliberately avoid external or high-risk side effects. Document upload and document processing validate ownership and return `SIMULATED_ONLY`; they do not create S3-backed file records or invoke OCR/extraction. Application submit validates readiness and returns `VALIDATED_ONLY` or `SIMULATED_ONLY`; it does not submit to payer portals or move the local session status. CAQH public responses expose metadata and `hasPassword`, not password material. Session summaries expose `documentCount` from the local document relation count; session detail returns active document metadata filtered by `deletedAt: null` and ordered newest-first.

What this endpoint does

Use case

Use this endpoint to test or preview document processing orchestration after a document ID already exists in QuickRCM.

Before calling

Authenticate with `credentialing:write`. Use a document ID associated with a session in the API-key organization.

Request and response behavior

Request guidance

`queueOnly` must remain true. The endpoint accepts `idempotencyKey` as a request-shape field, but it does not invoke OCR/extraction or persist an idempotent processing job in the current handler.

`documentId` is in the path, not the body.
`queueOnly` defaults to true and false is rejected.
Do not send raw OCR text, transcripts, or vendor payloads.

Response semantics

A 202 response returns `status: SIMULATED_ONLY`, `workflow: DOCUMENT_PROCESSING`, `documentId`, and a message. It does not update document classification, start OCR, run extraction, or return extracted document payloads. Workflow responses use `data.status`, `data.workflow`, `data.message`, and the relevant `sessionId` or `documentId` identifier.

No OCR or extraction service is invoked.
No document status update is promised by this public endpoint.
The response is local workflow simulation metadata.

Errors and retries

400 includes `queueOnly: false` or validation errors. 404 means the document was not found through the authenticated organization's session. Back off on 429 and avoid repeated simulation calls without purpose.

404 can mean the document belongs to another organization.
Do not retry authorization or ownership failures unchanged.

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

Name	Location	Required	Type	Description	Validation and safety notes
documentId	path	Yes	string	QuickRCM Credentialing document identifier. It must resolve through a session owned by 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.

Name	Location	Required	Type	Description	Validation and safety notes
queueOnly	body	No	boolean	Must be true for public Credentialing document processing simulation. False is rejected.	Default: true. Sensitive credential or storage-adjacent value; use placeholders only.
idempotencyKey	body	No	string	Caller-provided retry marker accepted by the request schema. Current public simulation handling does not persist de-duplication state.	Minimum length: 1. Maximum length: 128. Endpoint-specific compatibility key; universal Idempotency-Key header support is not declared.

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.

{
  "queueOnly": true,
  "idempotencyKey": "example-idempotencykey"
}

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.

202

Document processing request accepted as a simulated queue-only workflow.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "status": "SAFE_WRITE_DB_ONLY",
    "workflow": "example-workflow",
    "message": "Request failed",
    "sessionId": "00000000-0000-4000-8000-000000000001",
    "documentId": "00000000-0000-4000-8000-000000000001"
  },
  "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.