Authorizations API

Submit a reviewed RFA

Send exactly the retained packet the user reviewed, by fax or email.

POSThttps://app.mindbill.org/partner/v2/rfas/{rfaId}/submit

Call only after the user reviews the prepared packet and confirms the destination. Any change to the channel, destination, message, signed revision, or documents requires a fresh delivery preview.

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"

Must match the preview.

toRequired

string

Must match the preview.

packetId / sha256Required

string

The reviewed packet and its hash from delivery-preview.

recipientName / message

string

Must match the preview when supplied.

nonBusinessDates

string[]

Organization non-business dates (YYYY-MM-DD) used for deadline calculation.

Up to 366

Examples

curl 'https://app.mindbill.org/partner/v2/rfas/rfa_example/submit' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_API_KEY" \
  --header 'Idempotency-Key: rfa_example-submit-1' \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "fax",
  "to": "+15555550123",
  "packetId": "rfapkt_example",
  "sha256": "<sha256 from delivery-preview>"
}'

curl 'https://app.mindbill.org/partner/v2/rfas/rfa_example/submit' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example' \
  --header 'Idempotency-Key: rfa_example-submit-1' \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "fax",
  "to": "+15555550123",
  "packetId": "rfapkt_example",
  "sha256": "<sha256 from delivery-preview>"
}'

Response

200 OK

{ "data": { "transmissionId": "rfatx_example", "packetId": "rfapkt_example" } }

FieldTypeDescription

data.transmissionIdRequired

string

The delivery attempt.

data.packetIdRequired

string

The packet that was sent.