Collections

Check collections compliance

Runs a local pre-contact collections compliance check for the authenticated organization using supplied patient/contact context, active rules, and optional placement enrichment.

POSTNeeds publication reviewLocal writeCollectionsoperationId: checkCollectionsCompliancehttps://dev-api.quickintell.com/api/v1/collections/compliance/check

Needs publication reviewLocal writePatient financials

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

Local write

May mutate QuickRCM records. It does not prove live payer, EHR, clearinghouse, payment, or communication execution.

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 patient financials contract generated for POST /api/v1/collections/compliance/check. 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/collections/compliance/check, 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.

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.

Collections public API.

Collections APIs expose organization-scoped collection agency configuration, local bad debt placement tracking, recovery posting, placement dispute notes, safe debt validation notice simulation or queue evidence, and collections compliance rule/check workflows. The bearer API key selects the organization. Public callers should not send an `organizationId` tenant selector. The public handlers enforce organization scope when looking up collection agencies, bad debt placements, and compliance rules. For caller-supplied `patientId`, `patientAccountId`, and `claimIds` in placement creation, callers should use identifiers from the same authenticated organization; the public placement create endpoint stores those local references and does not document full referential validation for every supplied patient, account, or claim. For compliance checks, an optional `placementId` is used only for organization-scoped enrichment when found. These endpoints manage QuickRCM local workflow state and audit evidence. They do not by themselves transmit debt to an external agency, send mail, email, or SMS, collect payment, post cash, update payer systems, or create legal compliance guarantees. Use synthetic examples only, and keep request notes free of Protected Health Information (PHI), credentials, tokens, raw Electronic Data Interchange (EDI), transcripts, S3 keys, payer portal credentials, payment card details, and vendor payloads. Compliance language should expand Telephone Consumer Protection Act (TCPA) and Fair Debt Collection Practices Act (FDCPA) on first use and avoid presenting local checks as legal advice.

What this endpoint does

Use case

Use this before phone, text, email, or letter outreach when an integration needs QuickRCM's local allowed/violations/warnings decision for collections workflow controls.

Before calling

Authenticate with `collections:write`. Provide required `patientId` and `contactMethod`. Supply patient timezone, state, attorney, validation, call count, bankruptcy, deceased, dispute, and Telephone Consumer Protection Act (TCPA) context when available. If `placementId` is supplied and resolves in the authenticated organization, the handler can enrich missing attorney, bankruptcy, deceased, and dispute fields from that placement.

Request and response behavior

Request guidance

`contactMethod` must be `phone`, `text`, `email`, or `letter`. `patientState` is a two-character string. `patientTimezone` is optional; the implementation falls back to `America/New_York` when absent. `daysSinceFirstContact` and `callsThisWeek` are non-negative integers. Optional date strings are not format-refined in the public schema, so use consistent ISO date or datetime strings. Do not treat an absent or wrong-tenant optional `placementId` as a hard failure; enrichment simply will not occur.

Required fields are `patientId` and `contactMethod`.
Expand Telephone Consumer Protection Act (TCPA) and Fair Debt Collection Practices Act (FDCPA) on first use in final docs.
`placementId` is optional enrichment context, not a required selector.
Avoid logging raw patient identifiers or patient-contact context.

Response semantics

A 200 response returns `allowed`, `violations`, and `warnings`. Each violation/warning contains ruleName, ruleType, severity, message, and nullable legalReference. The handler attempts to persist an audit log when the optional log entity is available, but audit-log persistence failure is non-fatal and the compliance decision is still returned. The response is local workflow guidance, not legal advice or a guarantee that future outreach is lawful.

`allowed: false` means one or more local violations were returned.
`warnings` can be present even when `allowed` is true.
Do not present the result as legal advice or a regulatory guarantee.

Errors and retries

Fix missing required fields or invalid enum/bounds before retrying. Treat 429 as a backoff signal. Because compliance checks can write audit evidence, avoid tight repeated calls with identical patient/contact context.

400 can indicate missing patientId/contactMethod, invalid contactMethod, invalid state length, or negative count fields.
403 means the caller lacks Collections write access.
429 is the shared public API rate limit of 60 requests per minute.

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
patientId	body	Yes	string	Required QuickRCM patient identifier supplied for the contact scenario. Treat as patient-identifying in logs.	Minimum length: 1. Potential PHI; use synthetic examples and avoid logging raw values.
contactMethod	body	Yes	phone \| text \| email \| letter	Required proposed outreach channel: `phone`, `text`, `email`, or `letter`.	Enum values are declared in the Type column. Potential PHI; use synthetic examples and avoid logging raw values.
patientTimezone	body	No	string	Optional timezone string used for contact-window evaluation; implementation falls back to `America/New_York` when absent.	Minimum length: 1. Maximum length: 80. Potential PHI; use synthetic examples and avoid logging raw values.
patientState	body	No	string	Optional two-character state used for state-specific local rule checks.	Minimum length: 2. Maximum length: 2. Potential PHI; use synthetic examples and avoid logging raw values.
patientHasAttorney	body	No	boolean	Optional contact-context flag indicating attorney representation.	Potential PHI; use synthetic examples and avoid logging raw values.
debtValidationSent	body	No	boolean	Optional input indicating whether debt validation has been sent or recorded.	OpenAPI does not declare additional validation metadata.
daysSinceFirstContact	body	No	integer	Optional non-negative integer for debt validation timing checks.	Minimum value: 0.
callsThisWeek	body	No	integer	Optional non-negative integer for weekly call-count checks.	Minimum value: 0.
bankruptcyFiled	body	No	boolean	OpenAPI description is missing; publication gap.	File, artifact, or raw-payload adjacent; keep examples metadata-only.
deceasedDate	body	No	string	OpenAPI description is missing; publication gap.	Minimum length: 1.
disputedFlag	body	No	boolean	OpenAPI description is missing; publication gap.	OpenAPI does not declare additional validation metadata.
disputeResolved	body	No	boolean	OpenAPI description is missing; publication gap.	OpenAPI does not declare additional validation metadata.
tcpaConsentDate	body	No	string	Optional date string indicating Telephone Consumer Protection Act consent context.	Minimum length: 1. Potential PHI; use synthetic examples and avoid logging raw values.
tcpaOptOutDate	body	No	string	Optional date string indicating Telephone Consumer Protection Act opt-out context.	Minimum length: 1. Potential PHI; use synthetic examples and avoid logging raw values.
placementId	body	No	string	QuickRCM bad debt placement identifier. Placement read/write handlers look it up inside the organization selected by the bearer API key.	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.

{
  "patientId": "00000000-0000-4000-8000-000000000001",
  "contactMethod": "phone",
  "patientTimezone": "example-patienttimezone",
  "patientState": "example-patientstate",
  "patientHasAttorney": true,
  "debtValidationSent": true,
  "daysSinceFirstContact": 1,
  "callsThisWeek": 1,
  "bankruptcyFiled": true,
  "deceasedDate": "2026-06-08"
}

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

Collections compliance decision

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "allowed": true,
    "violations": [
      {
        "ruleName": "Example collections_compliance",
        "ruleType": "example-ruletype",
        "severity": "example-severity",
        "message": "Request failed",
        "legalReference": "example-legalreference"
      }
    ],
    "warnings": [
      {
        "ruleName": "Example collections_compliance",
        "ruleType": "example-ruletype",
        "severity": "example-severity",
        "message": "Request failed",
        "legalReference": "example-legalreference"
      }
    ]
  }
}

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