Sign in

Directories API

Preview bill delivery

Read delivery choices and a recommended route before submitting a bill.

GEThttps://app.mindbill.org/partner/v2/delivery-preview

Show routing choices after the user selects a claims administrator and payer. getDeliveryPreview() calls this endpoint. For an existing bill, getDeliveryOptions() uses /bills/{billId}/delivery-options with bills:read instead.

AuthenticationServer API key or browser session + Origin
Permissions by credentialServer: payers:read · Browser: payers:read
IdempotencyNot required

Use this URL with a server API key or a browser session and its exact allowed Origin. Both credentials use the same request and response contract. See the component API inventory for exact paths and SDK methods.

Query parameters

FieldTypeDescription
claimsAdministratorIdRequired
string

Selected claims-administrator directory id.

payerId
string

Selected payer-choice key from the search response's payers[].key.

injuryState
string

Two-letter state code; default CA.

Examples

Server API key request
curl 'https://app.mindbill.org/partner/v2/delivery-preview?claimsAdministratorId=admin_example&payerId=payer_example&injuryState=CA' \
  --header "Authorization: Bearer $MINDBILL_API_KEY"
Browser session request
curl 'https://app.mindbill.org/partner/v2/delivery-preview?claimsAdministratorId=admin_example&payerId=payer_example&injuryState=CA' \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example'

Response

200 OK

Response
{
  "payerName": "Example Insurance",
  "options": [],
  "contacts": {
    "claimsEmail": "billing@example.com"
  }
}
FieldTypeDescription
payerName
string

Resolved payer display name. No data wrapper.

recommended
object

Recommended option, when one is available; has the same shape as options[].

options[]
object[]

Available submission options. Portal routes are excluded.

options[].route / label / detail
string

Delivery route and display text.

options[].fallback
boolean

Whether this is a fallback option.

options[].confidence / payerName
string

Routing confidence and payer display name.

options[].target / chKey / payerId
string

Optional destination, clearinghouse key, and routing payer ID. Routing payer IDs differ from directory selection keys.

options[].printAndMail
boolean

Optional print-and-mail indicator.

options[].costUsd
number

Optional delivery cost in US dollars.

contacts
object

Optional or nullable faxNumber, claimsEmail, portalUrl, and mailingAddress properties.