Credentialing

Queue credentialing application submit

Validates Credentialing application readiness and returns a safe workflow response without payer portal submission.

POSTNeeds publication reviewExternal or credentialedCredentialingoperationId: submitCredentialingApplicationhttps://dev-api.quickintell.com/api/v1/credentialing/sessions/{sessionId}/submit

Needs publication reviewExternal or credentialedProvider 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 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/credentialing/sessions/{sessionId}/submit. 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/sessions/{sessionId}/submit, 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

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.

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	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

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.
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 Async Jobs

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 after provider info, signature reference, attestation, payer selections, and required classified documents are present and you want a public API readiness check or simulated queue response.

Before calling

Authenticate with `credentialing:write`. The session must be IN_PROGRESS, have provider firstName, lastName, and NPI, have a signature File reference, accepted attestation, at least one selected payer, and classified CV, DEA_CERTIFICATE, STATE_CDS_CERTIFICATE, BOARD_CERTIFICATION, and MALPRACTICE_INSURANCE document types.

Request and response behavior

Request guidance

`queueOnly` defaults to true and `validateOnly` defaults to false. At least one of `queueOnly` or `validateOnly` must be true; `queueOnly: false` is accepted only when `validateOnly: true`. `idempotencyKey` is accepted as a schema field, but current simulation handling does not persist de-duplication state.

Use `validateOnly: true` to check readiness without simulated queue messaging.
Required classified document types are CV, DEA_CERTIFICATE, STATE_CDS_CERTIFICATE, BOARD_CERTIFICATION, and MALPRACTICE_INSURANCE.
Do not document this endpoint as a live payer portal submission.

Response semantics

A 202 response returns `status: VALIDATED_ONLY` when `validateOnly` is true, otherwise `status: SIMULATED_ONLY`, with `workflow: APPLICATION_SUBMIT`. The endpoint does not submit to payer portals, does not move session status, and does not create external confirmation evidence. Workflow responses use `data.status`, `data.workflow`, `data.message`, and the relevant `sessionId` or `documentId` identifier.

202 is a safe local workflow response, not payer submission evidence.
`VALIDATED_ONLY` is returned when `validateOnly` is true; otherwise the accepted public path returns `SIMULATED_ONLY`.
No local session status transition is performed by this public handler.

Errors and retries

400 can indicate missing readiness prerequisites, invalid dates or body fields, or both `queueOnly` and `validateOnly` set to false. 404 means the session was not found in the API-key organization. Back off on 429.

400 can name missing signature, attestation, provider fields, selected payers, required document types, or invalid session status.
Do not retry readiness errors until the missing local session data has been corrected.

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
sessionId	path	Yes	string	QuickRCM Credentialing session identifier in the path. It must belong to the organization selected by the bearer API key; wrong-tenant IDs resolve as authorization/not-found failures.	Minimum length: 1. Tenant context is selected by the API key; do not treat this as a public tenant selector.

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	Safe-action flag for simulated public Credentialing submit workflow. Defaults to true; false is accepted only when validateOnly is true.	Default: true. Sensitive credential or storage-adjacent value; use placeholders only.
validateOnly	body	No	boolean	When true, validates application readiness and returns VALIDATED_ONLY without submit side effects. Takes precedence over queue simulation.	Default: false.
idempotencyKey	body	No	string	Optional caller retry marker capped at 128 characters. Do not include sensitive data; 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,
  "validateOnly": false,
  "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

Submit 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.