API Reference
Faxes API
Dispatch outbound digital medical faxes, compile custom practice cover sheets, and monitor real-time carrier delivery confirmations via the Intellectua REST API.
POST
/v1/faxes/sendDispatch outbound faxRequest Body Parameters
documentIdstring (Required)
ID of the existing stored document to transmit
toNumberstring (Required)
10-digit E.164 recipient fax number (e.g. +15552345678)
fromNumberstring (Optional)
Assigned clinic carrier line. Defaults to primary active DID.
recipientNamestring (Optional)
Attention recipient physician or clinic department name
coverPageboolean (Optional)
Whether to prepend branded PDF cover sheet (default: true)
coverPageNotesstring (Optional)
Confidential remarks printed onto the cover page
Example Dispatch Response200 OK
{
"success": true,
"transmissionId": "tx_sinch_88a7b6c5",
"carrier": "SINCH",
"status": "QUEUED",
"documentId": "doc_9f8e7d6c5b4a",
"recipientFaxNumber": "+15552345678",
"pageCount": 5,
"queuedAt": "2026-09-21T18:45:00.000Z"
}GET
/v1/faxes/:id/statusGet fax delivery statusCarrier Delivery States
QUEUEDFax is scheduled and waiting in the BullMQ worker queue.
PROCESSINGCarrier T.38 line handshake is actively transmitting audio pages.
COMPLETED / FILEDSuccessfully delivered to receiving physical fax machine.
REJECTED / FAILEDTransmission failed due to busy line or disconnect. Retry available.
Status Check Response200 OK
{
"id": "doc_9f8e7d6c5b4a",
"status": "COMPLETED",
"carrier": "SINCH",
"externalFaxId": "fax_sinch_10293847",
"sourceNumber": "+15559876543",
"destinationNumber": "+15552345678",
"receivedAt": "2026-09-21T18:45:00.000Z",
"completedAt": "2026-09-21T18:46:12.000Z",
"auditLogs": [
{ "actionType": "FAX_SENT", "createdAt": "2026-09-21T18:45:05.000Z" },
{ "actionType": "DELIVERY_CONFIRMED", "createdAt": "2026-09-21T18:46:12.000Z" }
]
}