SFTP EDI

Submit EDI file to SFTP

Validates or locally queues an organization-owned Electronic Data Interchange (EDI) file for a Secure File Transfer Protocol (SFTP) submission workflow while explicitly skipping live SFTP upload from the public API handler.

POSTNeeds publication reviewFile or artifactSFTP EDIoperationId: submitEdiFileToSftphttps://dev-api.quickintell.com/api/v1/sftp/files/{fileId}/submit

Needs publication reviewFile or artifactClaims and remittances

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, E4 file and artifact governance, 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

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 claims and remittances contract generated for POST /api/v1/sftp/files/{fileId}/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/sftp/files/{fileId}/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

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

SFTP EDI public API.

SFTP EDI documents Secure File Transfer Protocol (SFTP) handling for Electronic Data Interchange (EDI) file submission workflows. The public reference surface has one endpoint: `POST /api/v1/sftp/files/{fileId}/submit`. The public endpoint is intentionally safe-mode only. It can validate that the authenticated organization owns an EDI file, or queue local QuickRCM work by marking the file `QUEUED` and creating a local task. It does not perform a live SFTP upload, does not download response files, does not parse raw EDI, and does not return payer or clearinghouse payloads. Tenant context comes from the bearer API key used for the public API call, not from a public request-body organization selector. Document this module as a local validation and queueing surface around SFTP workflows. Avoid implying immediate payer delivery, SFTP receipt, claim acceptance, response polling, remittance import, or adjudication. Keep authentication wording scoped to the documented public bearer API key surface; do not generalize implementation-helper behavior into the public reference.

What this endpoint does

Use case

Use this endpoint after an EDI file already exists in QuickRCM and an integration needs either a no-side-effect readiness check or a local task queued for later internal handling.

Before calling

For public API callers, authenticate with a tenant-scoped bearer API key that has `sftp:write` scope. Resolve the QuickRCM `fileId` for the EDI file inside that API key's organization. Decide whether this call is `validateOnly` or `queueOnly`; the public handler rejects requests that choose neither mode.

Request and response behavior

Request guidance

`fileId` is the required path parameter. The request body supports `validateOnly`, `queueOnly`, and optional `externalSubmissionEnabled`. Set `validateOnly: true` for a readiness check with no file update or task creation. Set `queueOnly: true` to mark the file `QUEUED` and create a local task. `externalSubmissionEnabled` can only be `false`; do not document `true` as supported. Prefer sending exactly one of `validateOnly` or `queueOnly`; current handler behavior returns the validate-only response when both are true. No public `organizationId` or `idempotencyKey` field is declared for this operation.

Do not send `organizationId`; the bearer API key selects the organization for the public request.
Do not include raw EDI content, S3 keys, credentials, payer portal secrets, or SFTP connection details in the request.
`validateOnly: true` has no file update or task creation side effect.
`queueOnly: true` is local queueing only, not external SFTP delivery.
`externalSubmissionEnabled` is an explicit false-only guardrail for public examples.
No `idempotencyKey` is accepted by the documented public schema; clients should re-read state after ambiguous queue attempts.

Response semantics

HTTP 200 means the file belongs to the authenticated organization and is eligible for public safe-mode processing, but no local queue task or SFTP upload was created. HTTP 202 means QuickRCM updated the organization-owned file to `QUEUED` and created a local task, with `externalSubmissionSkipped: true`. Neither response proves an external SFTP upload, payer receipt, clearinghouse acceptance, or downstream EDI response.

`data.externalSubmissionSkipped` is always `true` for documented public success responses.
`data.taskId` appears only in the 202 queue-only response.
`meta.organizationId` echoes the authenticated tenant context; it is not a request selector.
Success responses are sanitized workflow metadata and do not contain raw EDI, S3 storage keys, filenames, payer payloads, credentials, or API keys.

Errors and retries

Treat 400 as an invalid body or missing safe-mode selection, 401 as missing or invalid public bearer API credentials, 403 as missing `sftp:write` scope or authorization failure, 404 as a file that does not belong to the API key organization or does not exist, 409 as an ineligible file state such as already queued or already submitted, and 429 as a backoff signal. The public schema has no idempotency key. After an ambiguous timeout or 5xx from a `queueOnly` request, re-check local file/task state before retrying; a retry may legitimately return 409 if the first attempt already moved the file to `QUEUED`.

400 can mean the request did not set either `validateOnly` or `queueOnly`.
403 can mean the public API key lacks `sftp:write` scope before file data is read.
404 should be documented without distinguishing missing files from wrong-organization files.
409 indicates the file is not eligible for this public safe-mode submission flow, including already queued or already submitted states.
A retry after an ambiguous queue-only failure may return 409 because the previous attempt already queued the file; do not treat that as proof of duplicate task creation.
429 should be retried with exponential backoff rather than tight polling.

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
fileId	path	Yes	string	QuickRCM File identifier in the path. The handler looks it up with both `id` and the organization selected by the public bearer API key.	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
validateOnly	body	No	boolean	Safe-mode request flag. When true, the handler checks file ownership and eligibility and returns `mode: VALIDATE_ONLY` without updating the file, creating a task, or uploading to SFTP.	Default: false. File, artifact, or raw-payload adjacent; keep examples metadata-only.
queueOnly	body	No	boolean	Safe-mode request flag. When true and `validateOnly` is not true, the handler marks the file `QUEUED`, creates a local task, and returns HTTP 202 with `mode: QUEUE_ONLY`.	Default: false. File, artifact, or raw-payload adjacent; keep examples metadata-only.
externalSubmissionEnabled	body	No	false	False-only public guardrail. The OpenAPI schema allows only `false`; live SFTP upload is not enabled through this public endpoint.	Enum values are declared in the Type column. File, artifact, or raw-payload adjacent; keep examples metadata-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.

{
  "validateOnly": true,
  "queueOnly": false,
  "externalSubmissionEnabled": false
}

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

EDI file validated without side effects

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "fileId": "00000000-0000-4000-8000-000000000001",
    "status": "VALIDATED",
    "mode": "VALIDATE_ONLY",
    "externalSubmissionSkipped": true
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

202

EDI file queued locally without live SFTP upload

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "fileId": "00000000-0000-4000-8000-000000000001",
    "status": "QUEUED",
    "mode": "QUEUE_ONLY",
    "taskId": "00000000-0000-4000-8000-000000000001",
    "externalSubmissionSkipped": true
  },
  "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