Sign in

API reference

Component API inventory

The shared business routes called by @mindbill/browser and the connected React components, including lookups available before a bill exists.

Use this inventory to see which APIs power the components when building your own UI. The routes below use the base URL https://app.mindbill.org. SDK methods can unwrap or normalize responses; their return values are not always identical to raw HTTP JSON.

Authentication and scope

Your backend creates a browser session with the permissions required for the current user. Browser requests send Authorization: Bearer <session token> and the exact Origin authorized for that session. Keep the long-lived server API key on your backend.

The components use GET /partner/v2/bill-dashboard for page-based lists, filters, and totals. GET /partner/v2/bills retains its cursor-based synchronization contract. Both endpoints accept either credential.

Use an organization-wide session for bill entry, bill lists, task dashboards, reports, organization settings, and RFAs. RFA access also requires the organization’s treatmentBilling feature and appropriate rfas permissions. For an existing-bill workflow, a bill-restricted session limits access to its allowed bill IDs. Grant only the permissions that the workflow needs; organization:manage allows billing-profile and custom-administrator writes. Team access separately requires team:manage, delegated from orgs:team:write; it manages existing MindBill accounts, not host-app accounts. Meanwhile, the bill-entry profile read uses bills:create.

Directories and delivery preview

GET/partner/v2/claims-administrators

Browse or search claims administrators, payer choices, and matching hints before a bill exists.

Session permission: payers:read

SDK methods: listClaimsAdministrators, searchClaimsAdministrators

Endpoint contract and examples →
GET/partner/v2/claims-administrators/{id}

Read a directory profile with contacts, instructions, payer information, and claim-number patterns.

Session permission: payers:read

SDK methods: getClaimsAdministratorDirectory

Endpoint contract and examples →
GET/partner/v2/diagnosis-codes

Search ICD-10-CM codes by code or description with offset pagination.

Session permission: payers:read

SDK methods: searchDiagnosisCodes

Endpoint contract and examples →
GET/partner/v2/delivery-preview

Preview delivery options for a selected claims administrator and payer before submission; the final route is resolved at submission.

Session permission: payers:read

SDK methods: getDeliveryPreview

Endpoint contract and examples →

Organization settings

GET/partner/v2/organization/team

List existing MindBill accounts and permitted role choices; does not list host-app accounts.

Session permission: team:manage

SDK methods: createOrganizationClient().getTeam

Related resource contract →
PATCH/partner/v2/organization/team/{id}

Update an eligible existing MindBill account role or active state; no account creation.

Session permission: team:manage

SDK methods: createOrganizationClient().updateTeamMember

Related resource contract →
GET/partner/v2/organization/claims-administrators

List active organization-specific claims administrators.

Session permission: organization:manage

SDK methods: createOrganizationClient().getClaimsAdministrators

Related resource contract →
POST/partner/v2/organization/claims-administrators

Create a custom fax, email, or mail destination.

Session permission: organization:manage

SDK methods: createOrganizationClient().createClaimsAdministrator

Related resource contract →
PATCH/partner/v2/organization/claims-administrators/{id}

Update a custom destination and its contact details.

Session permission: organization:manage

SDK methods: createOrganizationClient().updateClaimsAdministrator

Related resource contract →
DELETE/partner/v2/organization/claims-administrators/{id}

Remove a custom destination from future choices while preserving bill snapshots.

Session permission: organization:manage

SDK methods: createOrganizationClient().deleteClaimsAdministrator

Related resource contract →
GET/partner/v2/organization

Read the organization's profile, providers, locations, W-9 metadata, and onboarding checklist.

Session permission: organization:manage

SDK methods: getOrganization

Related resource contract →
GET/partner/v2/organization/billing-profile

Read saved billing profiles for bill entry with an organization-wide session; sensitive stored tax identifiers remain masked.

Session permission: bills:create

SDK methods: getBillingProfile

Related resource contract →
PUT/partner/v2/organization/billing-profile

Update practice identity and upsert billing or rendering providers by id or externalId; omitted records remain saved.

Session permission: organization:manage

SDK methods: saveBillingProfile

Related resource contract →
PUT/partner/v2/organization/locations

Upsert locations by id or externalId without deleting omitted locations.

Session permission: organization:manage

SDK methods: saveLocations

Related resource contract →
PUT/partner/v2/organization/w9

Upload the organization's current W-9 as a base64 PDF, up to 10 MB, with an optional tax year.

Session permission: organization:manage

SDK methods: saveW9

Related resource contract →

Requests for Authorization

GET/partner/v2/browser/rfas/creation-context

Search saved patient claims and active rendering providers for an unsigned draft, with separate cursors. Browser-session-only route; requires an organization-wide session and treatment access.

Session permission: rfas:create

SDK methods: createRfaClient().getCreationContext

GET/partner/v2/rfas

List authorization requests with filtered status totals and cursor pagination. Requires an organization-wide session and treatment access.

Session permission: rfas:read

SDK methods: createRfaClient().list

GET/partner/v2/rfas/{rfaId}

Read the authorization request, item decisions, and delivery evidence.

Session permission: rfas:read

SDK methods: createRfaClient().get

POST/partner/v2/rfas

Save an unsigned authorization draft using a stable idempotency key. Does not sign or send a fax.

Session permission: rfas:create

SDK methods: createRfaClient().createDraft

GET/partner/v2/rfas/{rfaId}/documents/{documentId}

Download a stored RFA document within the authorized organization.

Session permission: documents:read

SDK methods: createRfaClient().getDocument

POST/partner/v2/rfas/{rfaId}/documents

Upload a clinical or supporting PDF with content revision and a stable idempotency key.

Session permission: rfas:edit

SDK methods: createRfaClient().uploadDocument

POST/partner/v2/rfas/{rfaId}/signing-preview

Prepare the exact form snapshot for human review before signing.

Session permission: rfas:sign

SDK methods: createRfaClient().prepareSigning

POST/partner/v2/rfas/{rfaId}/sign

Apply the saved physician signature after authorized human review of the exact snapshot.

Session permission: rfas:sign

SDK methods: createRfaClient().sign

POST/partner/v2/rfas/{rfaId}/packet

Preview the assembled stored documents and generated fax cover; sends nothing.

Session permission: rfas:read

SDK methods: createRfaClient().previewPacket

POST/partner/v2/rfas/{rfaId}/fax

Explicitly send the reviewed packet to a confirmed fax destination with a stable idempotency key.

Session permission: rfas:act

SDK methods: createRfaClient().sendFax

POST/partner/v2/rfas/{rfaId}/fax/refresh

Reconcile existing fax delivery evidence without sending another transmission.

Session permission: rfas:act

SDK methods: createRfaClient().refreshFaxes

Bills, documents, and reports

GET/partner/v2/reports/payments

Review confirmed payment entries and filtered totals; requires an organization-wide session. Pending EOR/835 amounts and historical legacy entries are excluded.

Session permission: bills:read

SDK methods: getPaymentReview

POST/partner/v2/bills

Submit a complete bill, including its supporting documents, from an organization-wide browser session.

Session permission: bills:create

SDK methods: submitBill

Related resource contract →
GET/partner/v2/bill-dashboard

List and filter the partner's bills in the session organization; requires an organization-wide session. Use renderingProviderId from filters.renderingProviders for a rendering-doctor filter.

Session permission: bills:read

SDK methods: getBills

Related resource contract →
GET/partner/v2/bills/{billId}/status

Read the status snapshot used by the connected bill status component.

Session permission: bills:read

SDK methods: getStatus

Related resource contract →
GET/partner/v2/bills/{billId}/lifecycle

Load the bill's timeline, balance, documents, payments, and available follow-up actions.

Session permission: bills:read

SDK methods: getLifecycle

Related resource contract →
POST/partner/v2/bills/{billId}/actions

Perform a supported bill action, including notes, close/reopen, payments, second review, resubmission, a new bill, duplicates, or status reporting.

Session permission: bills:act

SDK methods: addNote, closeBill, reopenBill, postPayment, submitSecondReview, resubmitBill, submitNewBill, sendDuplicateBill, reportBillStatus

Related resource contract →
POST/partner/v2/sandbox/bills/{billId}/simulate

Simulate a bill lifecycle outcome in sandbox; unavailable for live sessions.

Session permission: bills:act

SDK methods: simulateSandbox

Related resource contract →
GET/partner/v2/bills/{billId}/delivery-options

Read the available delivery options and recommended route for an existing bill.

Session permission: bills:read

SDK methods: getDeliveryOptions

Related resource contract →
GET/partner/v2/bills/{billId}/documents/{attachmentId}

Download a supporting attachment as PDF bytes.

Session permission: documents:read

SDK methods: getAttachment

Related resource contract →
GET/partner/v2/bills/{billId}/eors/{documentId}

Download an explanation of review document as PDF bytes.

Session permission: eors:read

SDK methods: getEor

Related resource contract →
GET/partner/v2/bills/{billId}/packet

Download the bill submission packet as PDF bytes.

Session permission: bills:read

SDK methods: getPacket

Related resource contract →
POST/partner/v2/bills/{billId}/courtesy-forward

Preview or send a courtesy copy of an existing submission. Sending requires a stable idempotency key.

Session permission: bills:act

SDK methods: previewCourtesyCopy, sendCourtesyCopy

Related resource contract →
GET/partner/v2/bills/{billId}/submissions/{attemptId}/artifacts/{artifactId}

Download exact retained electronic bill or attachment bytes for the selected submission. Read artifact IDs from lifecycle.submissionDetails; missing retained files return 404, never a regenerated current packet.

Session permission: bills:read

SDK methods: getSubmissionArtifact

GET/partner/v2/bill-tasks

Read the partner's bill task dashboard, waiting items, claims-administrator and rendering-doctor filters with an organization-wide session. renderingProviderId filters both tasks and waiting bills.

Session permission: bills:read

SDK methods: getBillTasks

Related resource contract →
GET/partner/v2/reports/service-line-items

Read service-line reporting for the partner's bills with optional from/to dates and an organization-wide session.

Session permission: bills:read

SDK methods: getServiceLineItems

Related resource contract →
GET/partner/v2/reports/productivity

Read biller productivity for a required from/to date range with an organization-wide session.

Session permission: bills:read

SDK methods: getProductivity

Related resource contract →