Credentialing

Update credentialing CAQH info

Creates or updates non-secret CAQH metadata for an organization-scoped Credentialing session.

PUTNeeds publication reviewExternal or credentialedCredentialingoperationId: updateCredentialingCaqhhttps://dev-api.quickintell.com/api/v1/credentialing/sessions/{sessionId}/caqh

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 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 PUT /api/v1/credentialing/sessions/{sessionId}/caqh. 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 PUT /api/v1/credentialing/sessions/{sessionId}/caqh, 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	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	Not indicated by OpenAPI	No generic polling contract is published from this page.
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

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.
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	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 store CAQH identifiers, username metadata, and attestation date tracking without transmitting passwords or portal secrets through the public API.

Before calling

Authenticate with `credentialing:write`. Confirm the session exists in the API-key organization. Keep CAQH passwords and portal credentials out of the request.

Request and response behavior

Request guidance

Only `caqhId`, `caqhUsername`, `lastAttestationDate`, and `nextAttestationDue` are accepted. Date values are parsed as dates by the handler. Do not send password fields, encrypted password material, MFA secrets, or payer portal credentials.

The public API does not accept CAQH password fields.
`hasPassword` is response metadata, not a password value.
Use ISO date strings consistently for attestation dates.

Response semantics

The response returns `data.caqhInfo` with metadata and `hasPassword`. It intentionally omits password and encrypted password fields.

Response omits CAQH password and encrypted password data.
Returned dates are nullable ISO datetimes when present.
This endpoint does not attest or submit CAQH data externally.

Errors and retries

400 can indicate invalid date or field validation. 404 means the session was not found in the authenticated organization. Do not retry by adding secret fields.

400 can include invalid date parsing errors.
Credential or scope failures must be fixed before retry.

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
caqhId	body	No	string	CAQH provider identifier metadata for the credentialing session. Nullable and capped at 100 characters; do not use it as a secret.	Maximum length: 100. Sensitive credential or storage-adjacent value; use placeholders only.
caqhUsername	body	No	string	CAQH username metadata. Nullable and capped at 255 characters; treat as sensitive account context and never pair it with passwords in public API requests.	Maximum length: 255. Sensitive credential or storage-adjacent value; use placeholders only.
lastAttestationDate	body	No	string	Date string for the last known CAQH attestation date. Null clears the stored value; invalid date strings return 400.	Minimum length: 1.
nextAttestationDue	body	No	string	Date string for the next expected CAQH attestation due date. Null clears the stored value; invalid date strings return 400.	Minimum length: 1.

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.

{
  "caqhId": "00000000-0000-4000-8000-000000000001",
  "caqhUsername": "Example credentialing_caqh",
  "lastAttestationDate": "2026-06-08",
  "nextAttestationDue": "example-nextattestationdue"
}

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

CAQH info updated with secret fields omitted.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "caqhInfo": {
      "id": "00000000-0000-4000-8000-000000000001",
      "sessionId": "00000000-0000-4000-8000-000000000001",
      "caqhId": "00000000-0000-4000-8000-000000000001",
      "caqhUsername": "Example credentialing_caqh",
      "hasPassword": true,
      "lastAttestationDate": "2026-06-08T10:15:30Z",
      "nextAttestationDue": "2026-06-08T10:15:30Z",
      "createdAt": "2026-06-08T10:15:30Z",
      "updatedAt": "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.