FxFaximus Developers
Production APIPortal

Documents

Create a document record, upload a PDF to a presigned URL, and complete the upload for a fax job.

StartAuthenticationDocumentsFax JobsInboxEmail FaxWebhooksErrorsOpenAPI

Reference

Documents

POST/v1/documentsCreate a document uploadCreate a presigned upload target for a PDF before submitting a fax job.fax:send

Create a presigned upload target for a PDF before submitting a fax job.

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
createDocument
Response example
{
  "documentId": "7f067f97-26f6-4bc9-8a19-3c0df6f17db8",
  "status": "pending_upload",
  "uploadUrl": "https://faximus-prod-documents.s3.amazonaws.com/",
  "uploadFields": {
    "key": "opaque-upload-key",
    "Content-Type": "application/pdf",
    "policy": "base64-policy",
    "x-amz-checksum-sha256": "jxTkX86hZnpd1L6iVDsUOxTkX86hZnpd1L6iVDsUOw==",
    "x-amz-signature": "signature"
  },
  "expiresAt": "2026-06-20T14:15:00.000Z",
  "completeUrl": "/v1/documents/7f067f97-26f6-4bc9-8a19-3c0df6f17db8/complete",
  "createdAt": "2026-06-20T14:12:48.000Z",
  "updatedAt": "2026-06-20T14:12:48.000Z"
}
POST/v1/documents/{documentId}/completeComplete an uploadMark an uploaded PDF as ready for attachment to outbound fax jobs.fax:send

Mark an uploaded PDF as ready for attachment to outbound fax jobs.

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
completeDocument
Response example
{
  "documentId": "7f067f97-26f6-4bc9-8a19-3c0df6f17db8",
  "status": "uploaded",
  "contentType": "application/pdf",
  "sizeBytes": 1048576,
  "createdAt": "2026-06-20T14:12:48.000Z",
  "updatedAt": "2026-06-20T14:13:07.000Z"
}
GET/v1/documents/{documentId}Retrieve document statusRead customer-safe document metadata and attachment readiness.fax:read

Read customer-safe document metadata and attachment readiness.

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
getDocument
Response example
{
  "documentId": "7f067f97-26f6-4bc9-8a19-3c0df6f17db8",
  "status": "uploaded",
  "contentType": "application/pdf",
  "sizeBytes": 1048576,
  "createdAt": "2026-06-20T14:12:48.000Z",
  "updatedAt": "2026-06-20T14:13:07.000Z"
}