Authorizations API

Forward an RFA

Re-send a retained packet, or compose a forwarded copy with chosen documents, to a fax or email recipient.

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

Send a sent request to an adjuster or another recipient. Give packetId alone to re-send exact bytes; add documentIds to compose a copy with a forward cover sheet that keeps the original sent, received, and due dates.

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"

Delivery channel.

toRequired

string

E.164 fax number or email address.

packetId

string

A retained packet of this request. Send packetId, documentIds, or both.

documentIds

string[]

Documents to include: signed form, clinical reports, supporting records, UR responses, or other documents. Saved fax covers and signing previews cannot be forwarded.

Up to 100

message / recipientName

string

Printed on the forward cover sheet (and in the email body).

1,000 / 200 characters

Examples

curl 'https://app.mindbill.org/partner/v2/rfas/rfa_example/forwards' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_API_KEY" \
  --header 'Idempotency-Key: rfa_example-forward-1' \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "email",
  "to": "adjuster@example.com",
  "documentIds": [
    "rfadoc_form_example"
  ],
  "message": "Forwarding the signed request."
}'

curl 'https://app.mindbill.org/partner/v2/rfas/rfa_example/forwards' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example' \
  --header 'Idempotency-Key: rfa_example-forward-1' \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "email",
  "to": "adjuster@example.com",
  "documentIds": [
    "rfadoc_form_example"
  ],
  "message": "Forwarding the signed request."
}'

Response

200 OK

{ "data": { "transmissionId": "rfatx_forward_example", "packetId": "rfapkt_forward_example" } }

FieldTypeDescription

data.transmissionIdRequired

string

The forward attempt.

data.packetIdRequired

string

The packet sent: the exact packet for a re-send, or a new packet with source forward for a composed copy.