Sign in

Authorizations API

Prepare the RFA packet for delivery

Retain an immutable signed packet for a chosen channel and recipient so the user can review its exact bytes.

POSThttps://app.mindbill.org/partner/v2/rfas/{rfaId}/delivery-preview

After signing, prepare the packet, download it with GET /rfas/{rfaId}/packets/{packetId}, and show it to the user before submitting. Preparation does not send and works in sandbox.

AuthenticationServer API key or browser session + Origin
Permissions by credentialServer: rfas:write · Browser: rfas:act
IdempotencyRequired for safe retries
Organization capabilitytreatmentBilling must be enabled

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.

Path parameters

FieldTypeDescription
rfaIdRequired
string

MindBill RFA identifier.

Request body

FieldTypeDescription
channelRequired
"fax" | "email" | "download"

Delivery channel for the retained packet.

to
string

Verified authorization fax in E.164 format, or email address. Not used for download.

recipientName
string

Recipient or adjuster name printed on the cover; must match at submission.

1–200 characters
message
string

Cover message (and email body); must match at submission.

Up to 1,000 characters
documentIdsRequired
string[]

The current signed form and clinical support to include.

2–100 unique IDs

Examples

Server API key
curl 'https://app.mindbill.org/partner/v2/rfas/rfa_example/delivery-preview' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_API_KEY" \
  --header 'Idempotency-Key: rfa_example-preview-1' \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "fax",
  "to": "+15555550123",
  "recipientName": "Utilization Review",
  "documentIds": [
    "rfadoc_form_example",
    "rfadoc_report_example"
  ]
}'
Browser session
curl 'https://app.mindbill.org/partner/v2/rfas/rfa_example/delivery-preview' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example' \
  --header 'Idempotency-Key: rfa_example-preview-1' \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "fax",
  "to": "+15555550123",
  "recipientName": "Utilization Review",
  "documentIds": [
    "rfadoc_form_example",
    "rfadoc_report_example"
  ]
}'

Response

200 OK

Response
{ "data": { "packetId": "rfapkt_example", "sha256": "3f1c…64 hex characters…", "contentRevision": 2 } }
FieldTypeDescription
data.packetIdRequired
string

Retained packet identifier.

data.sha256Required
string

Hash of the retained packet bytes; required to submit.

data.contentRevisionRequired
integer

Signed content revision the packet was built from.