Production APIPortal

OpenAPI Files

Find the live API specification and the OpenAPI contract files used by the Faximus developer reference.

Start Authentication Documents Fax Jobs Inbox Email Fax Webhooks Errors OpenAPI

Contract

OpenAPI files

Live API YAML

https://api.faximus.io/openapi.yaml

Docs contract JSON

/developer/contracts/0c29c11b0209e2f92bb7faa0642ac852b0398e9029cda59ada15a231492c4bf3/openapi.json

These docs use OpenAPI 3.1.0, contract 0c29c11b0209. Capability manifest · Build inputs. Live API YAML may show a different served version during a rollout.

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