Authorizations API

Reconcile an uncertain fax attempt

Associate an uncertain live fax attempt with the provider's message after verification.

POSThttps://app.mindbill.org/partner/v2/rfas/{rfaId}/transmissions/{transmissionId}/reconcile-fax

Use when a fax attempt's outcome is unknown and you have the fax provider's message ID. It never sends another fax, creates a replacement attempt, establishes receipt, or infers approval.

AuthenticationServer API key or browser session + Origin

Permissions by credentialServer: rfas:write (operator role) · 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.

transmissionIdRequired

string

The uncertain transmission.

Request body

FieldTypeDescription

providerMessageIdRequired

string

Candidate fax provider message ID to verify.

UUID

expectedContentRevisionRequired

integer

From a fresh RFA read.

expectedUpdatedAtRequired

string

From a fresh RFA read.

ISO date-time

Examples

curl 'https://app.mindbill.org/partner/v2/rfas/rfa_example/transmissions/rfatx_example/reconcile-fax' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_API_KEY" \
  --header 'Idempotency-Key: rfatx_example-reconcile-1' \
  --header 'Content-Type: application/json' \
  --data '{
  "providerMessageId": "00000000-0000-4000-8000-000000000000",
  "expectedContentRevision": 2,
  "expectedUpdatedAt": "2026-10-01T17:06:00.000Z"
}'

curl 'https://app.mindbill.org/partner/v2/rfas/rfa_example/transmissions/rfatx_example/reconcile-fax' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example' \
  --header 'Idempotency-Key: rfatx_example-reconcile-1' \
  --header 'Content-Type: application/json' \
  --data '{
  "providerMessageId": "00000000-0000-4000-8000-000000000000",
  "expectedContentRevision": 2,
  "expectedUpdatedAt": "2026-10-01T17:06:00.000Z"
}'

Response

200 OK

{ "data": { "transmissionId": "rfatx_example", "providerMessageId": "00000000-0000-4000-8000-000000000000", "reconciled": true } }

FieldTypeDescription

data.transmissionIdRequired

string

The reconciled attempt.

data.providerMessageIdRequired

string

The verified provider message.

data.reconciledRequired

true

Always true on success.