Production APIPortal

Send a Fax

Submit a fax job with an uploaded document and an idempotency key, then check its delivery status.

Start Authentication Documents Fax Jobs Inbox Email Fax Webhooks Errors OpenAPI

Reference

Fax Jobs

Set senderIdentity to an assigned or allowed shared sending number for your account.

POST/v1/fax-jobsSubmit a fax jobSend one or more staged documents from an assigned sending fax number to a destination number.fax:send

Send one or more staged documents from an assigned sending fax number to a destination number.

Required scope: fax:send
Authentication: Bearer API key or customer session; account roles and scopes also apply
Base URL: https://api.faximus.io
OpenAPI operation: createFaxJob

Requires Idempotency-Key. Reuse the same key when retrying the same submission.

Response example

{
  "jobId": "63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
  "status": "queued",
  "canonicalState": "pending",
  "createdAt": "2026-06-20T14:18:00.000Z",
  "updatedAt": "2026-06-20T14:18:00.000Z",
  "statusUrl": "/v1/fax-jobs/63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
  "destinationNumber": "+15551234567",
  "senderIdentity": "+18643106131",
  "documentCount": 1,
  "highResolutionColorCopy": {
    "enabled": true,
    "status": "active",
    "expiresAt": "2026-06-23T16:00:00.000Z",
    "lastAccessedAt": null,
    "downloadCount": 0
  },
  "delivery": {
    "status": "queued",
    "state": "pending",
    "confidence": "none"
  }
}

GET/v1/fax-jobsList fax jobsPage through outbound fax jobs for the account with cursor pagination.fax:read

Page through outbound fax jobs for the account with cursor pagination.

Required scope: fax:read
Authentication: Bearer API key or customer session; account roles and scopes also apply
Base URL: https://api.faximus.io
OpenAPI operation: listFaxJobs

Response example

{
  "items": [
    {
      "jobId": "63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
      "status": "completed",
      "canonicalState": "completed",
      "destinationNumber": "+15551234567",
      "senderIdentity": "+18643106131",
      "correlationId": "claim-10001",
      "createdAt": "2026-06-20T14:18:00.000Z",
      "updatedAt": "2026-06-20T14:22:41.000Z",
      "statusUrl": "/v1/fax-jobs/63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
      "delivery": { "status": "delivered", "state": "delivery_confirmed", "confidence": "high" }
    }
  ],
  "nextCursor": null
}

GET/v1/fax-jobs/{jobId}Get a fax jobRead status, delivery confidence, document summary, and customer-safe delivery evidence.fax:read

Read status, delivery confidence, document summary, and customer-safe delivery evidence.

Required scope: fax:read
Authentication: Bearer API key or customer session; account roles and scopes also apply
Base URL: https://api.faximus.io
OpenAPI operation: getFaxJob

Response example

{
  "jobId": "63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
  "status": "completed",
  "canonicalState": "completed",
  "destinationNumber": "+15551234567",
  "senderIdentity": "+18643106131",
  "createdAt": "2026-06-20T14:18:00.000Z",
  "updatedAt": "2026-06-20T14:22:41.000Z",
  "statusUrl": "/v1/fax-jobs/63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
  "documentCount": 1,
  "documents": [
    { "documentId": "7f067f97-26f6-4bc9-8a19-3c0df6f17db8", "fileName": "claim-form.pdf" }
  ],
  "delivery": {
    "status": "confirmed",
    "state": "delivery_confirmed",
    "confidence": "high",
    "completedAt": "2026-06-20T14:22:41.000Z"
  }
}

POST/v1/fax-jobs/{jobId}/resendResend a fax jobCreate a controlled resend from a prior job when the account has send entitlement.fax:send

Create a controlled resend from a prior job when the account has send entitlement.

Required scope: fax:send
Authentication: Bearer API key or customer session; account roles and scopes also apply
Base URL: https://api.faximus.io
OpenAPI operation: resendFaxJob

A resend creates a new fax transmission. Reconcile uncertain or partial delivery before deliberately requesting it; callback replay is separate.

Response example

{
  "jobId": "63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
  "status": "queued",
  "canonicalState": "pending",
  "createdAt": "2026-06-20T14:18:00.000Z",
  "updatedAt": "2026-06-20T14:18:00.000Z",
  "statusUrl": "/v1/fax-jobs/63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
  "destinationNumber": "+15551234567",
  "senderIdentity": "+18643106131",
  "documentCount": 1,
  "highResolutionColorCopy": {
    "enabled": true,
    "status": "active",
    "expiresAt": "2026-06-23T16:00:00.000Z",
    "lastAccessedAt": null,
    "downloadCount": 0
  },
  "delivery": {
    "status": "queued",
    "state": "pending",
    "confidence": "none"
  }
}

POST/v1/fax-jobsConditional native test jobRun a deterministic fixture scenario with a stored test credential and generated test document.fax:send

Run a deterministic fixture scenario with a stored test credential and generated test document.

Required scope: fax:send
Authentication: Bearer API key or customer session; account roles and scopes also apply
Base URL: https://api.faximus.io
OpenAPI operation: createFaxJob

Response schema: NativeTestFaxJobResponse

The composer can display this test-mode example but cannot run it. Check the Developer tools in your portal for supported backends and modes before running it with the SDK or cURL.

Response example

{
  "faxJobId": "63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
  "state": "accepted",
  "scenario": "success",
  "ordinal": 0,
  "synthetic": true,
  "businessMode": "test",
  "catalogVersion": "developer-test-scenarios.v2",
  "carrierDeliveryProven": false,
  "deliveryStatus": "synthetic",
  "deliveryConfidence": null
}

POST/v1/fax-jobs/{jobId}/cancelConditional test-job cancellationCancel an eligible accepted synthetic job using retained identity.fax:send

Cancel an eligible accepted synthetic job using retained identity.

Required scope: fax:send
Authentication: Bearer API key or customer session; account roles and scopes also apply
Base URL: https://api.faximus.io
OpenAPI operation: cancelTestFaxJob

Response schema: NativeTestFaxJobResponse

The composer can display this test-mode example but cannot run it. Check the Developer tools in your portal for supported backends and modes before running it with the SDK or cURL.

Response example

{
  "faxJobId": "63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
  "state": "canceled",
  "scenario": "cancellation",
  "ordinal": 3,
  "synthetic": true,
  "businessMode": "test",
  "catalogVersion": "developer-test-scenarios.v2",
  "carrierDeliveryProven": false,
  "deliveryStatus": "synthetic",
  "deliveryConfidence": null
}

Quick send

Submit a fax job

Set senderIdentity to an assigned or allowed shared sending number for your account.

curl

curl -X POST "$FAXIMUS_API_BASE/v1/fax-jobs" \
  -H "Authorization: Bearer $FAXIMUS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $FAXIMUS_IDEMPOTENCY_KEY" \
  -d '{
    "senderIdentity": "+18643106131",
    "destinationNumber": "+15551234567",
    "documents": [{ "documentId": "7f067f97-26f6-4bc9-8a19-3c0df6f17db8" }],
    "highResolutionColorCopy": true,
    "correlationId": "claim-10001"
  }'

Response

202 Accepted

{
  "jobId": "63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
  "status": "queued",
  "canonicalState": "pending",
  "createdAt": "2026-06-20T14:18:00.000Z",
  "updatedAt": "2026-06-20T14:18:00.000Z",
  "statusUrl": "/v1/fax-jobs/63b3ab55-23b2-4a57-bf1c-519f4b151ed6",
  "destinationNumber": "+15551234567",
  "senderIdentity": "+18643106131",
  "documentCount": 1,
  "highResolutionColorCopy": {
    "enabled": true,
    "status": "active",
    "expiresAt": "2026-06-23T16:00:00.000Z",
    "lastAccessedAt": null,
    "downloadCount": 0
  },
  "delivery": {
    "status": "queued",
    "state": "pending",
    "confidence": "none"
  }
}

Full schema available in OpenAPI