sinch-fax-api

What problem does it solve?

Sinch Fax API lets you send and receive faxes programmatically. It supports multiple file formats, webhooks for incoming faxes, fax-to-email delivery, and automatic retries. Used for healthcare, legal, financial, and government applications where fax remains a required communication channel.

Core Features & Use Cases

• Fax Services — Logical containers for fax configuration. Associate numbers, set defaults, and manage routing.
• Fax Numbers — Phone numbers provisioned for fax. Must be configured in your Sinch dashboard.
• Faxes — Individual fax transmissions (inbound or outbound). Each has a unique ID, status, and metadata.
• Fax statuses — QUEUED → IN_PROGRESS → COMPLETED or FAILURE. Error details in errorType and errorMessage fields.
• Supported formats — PDF (most reliable), DOC, DOCX, TIF/TIFF, JPG, PNG, TXT, HTML.
• Webhooks/Callbacks — HTTP POST notifications for fax events. Default content type is multipart/form-data (fax content as attachment).
• Cover Pages — Customizable cover pages per service. Attach via coverPageId and coverPageData on send.
• Fax-to-Email — Incoming faxes auto-forwarded to configured email.
• Retries — Auto-retry on failure. Default set per fax service; maximum: 5.
• Retention — Fax logs and media retained for 13 months. Use DELETE /faxes/{id}/file to remove earlier.

Quick Start

Configure a fax service and send a test fax using a sample contentUrl via Node.js SDK or REST API.