API Reference

API Docs For Bill Audits, Reports, Pricing Context, And Letters

This reference documents the integration model for partners. It keeps examples synthetic, avoids protected health information, and points production access through partner review.

Review WebhooksRequest Sandbox

Production credentials are issued only after security, privacy, and commercial review.

Preflix AI API documentation workspace with endpoint rows and schema panels
2Auth modes
6Core endpoints
3SDK tracks

Authentication

Start With Least-Privilege Credentials

Developer access should keep secrets server-side, scope keys by environment, and separate employer analytics from employee bill workflows.

API Keys

Use scoped server-side keys for sandbox and partner integrations. Never expose keys in browser code or mobile clients.

OAuth For Platforms

Enterprise platform connections can use OAuth-style authorization when the partner needs user-initiated handoff flows.

Webhook Signing

Every webhook payload should be verified with timestamped HMAC signatures before work is queued.

Quickstart

Create A Bill Record From Safe Document References

The quickstart shows the shape of the request without uploading files or showing medical records on a public page.

  • Create a bill record with partner-safe identifiers.
  • Attach document references from a protected upload workflow.
  • Start the audit job and listen for webhook completion.
Node.jsPOST /v1/bills
const response = await fetch("https://api.preflixai.com/v1/bills", {
  method: "POST",
  headers: {
    "Authorization": "Bearer PREFLIXAI_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    external_id: "case_104",
    document_refs: ["doc_bill", "doc_eob"]
  })
});

const bill = await response.json();

Endpoints

Core Routes For The Audit Lifecycle

The table is intentionally small so partners can map each endpoint to a specific user or operations workflow.

Preflix AI API endpoint reference
MethodPathDescription
POST/v1/billsCreate a bill record and attach upload references.
POST/v1/bills/{bill_id}/auditStart an audit job after required documents are attached.
GET/v1/bills/{bill_id}/reportRetrieve a structured report once the audit is complete.
GET/v1/pricesSearch price transparency context by procedure, code, payer, and location.
GET/v1/cpt-lookupReturn plain-language code context and benchmark notes.
POST/v1/lettersDraft a dispute or records-request letter from selected findings.

Schemas

Synthetic Examples For Common Response Shapes

Examples use synthetic identifiers and no real patient, provider, payer, or bill details.

BillJSON

A bill record contains partner references, document status, audit status, and safe user-facing display fields.

{
  "id": "bill_8f4",
  "status": "ready_for_audit",
  "document_count": 2,
  "created_at": "2026-01-15T18:22:00Z"
}
Audit FindingJSON

Findings are structured for risk, evidence notes, suggested next steps, and downstream letter generation.

{
  "finding_id": "find_21",
  "risk": "medium",
  "category": "duplicate_charge",
  "next_step": "request_itemized_review"
}

Errors

Failures Should Tell The Partner What To Do Next

Error responses should be actionable, retry-safe where possible, and careful not to echo protected document content.

Preflix AI API error handling
StatusReasonNext Step
400Invalid requestFix schema, missing fields, or unsupported file references.
401UnauthorizedCheck key scope, environment, and Authorization header.
409Workflow conflictConfirm bill status before restarting an audit or letter job.
422Document needs reviewAsk the user for a clearer bill, EOB, or missing context.
429Rate limitedBack off with jitter and retry after the returned window.

SDKs And Postman

Developer Tooling Should Make The Safe Path Easy

Production SDKs should reduce signing mistakes, centralize retries, and keep sensitive data out of logs.

Node.js SDK

Helper package shape for server-side bill records, audit jobs, report polling, and webhook verification.

Python SDK

Helper package shape for advocacy operations, async audit workflows, and internal case-management automation.

Postman Collection

The collection should include sandbox examples, environment variables, and signature verification samples.

Next Developer Step

Pair The API Reference With Signed Webhook Handling

Open Webhook GuideRequest Sandbox