The DDSFAX API
DDSFAX includes a REST API for sending faxes, tracking delivery, searching transmissions, and reading AI document-intelligence results — classification, OCR, and structured data extraction on every inbound fax. API access is included in the $189/year plan with no per-call fees, and every request is covered by the same HIPAA controls as the dashboard: TLS in transit, 256-bit AES at rest, and an append-only audit log.
How do I get an API key?
Sign up at ddsfax.com, then enable API access in your
dashboard settings. Keys are prefixed with dds_ and are passed as a Bearer token
on every request: Authorization: Bearer dds_.... An active subscription is
required to transmit.
How do I send a fax with the API?
One POST request. Point media_url at an HTTPS-hosted PDF and provide the
destination as a 10-digit US number or E.164. The API responds 202 immediately
with the fax queued for transmission.
curl -X POST https://www.ddsfax.com/api/v1/faxes \
-H "Authorization: Bearer dds_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+13055551234",
"media_url": "https://example.com/referral.pdf"
}'Response:
{
"id": "fx_8Kj3...",
"telnyx_fax_id": "5a1c...",
"status": "queued",
"to": "+13055551234",
"from": "+13055559876"
}How do I check delivery status?
Poll the fax by ID. The response includes the stored record plus live carrier status in telnyx_status (queued → sending → delivered, or failed with a reason).
curl https://www.ddsfax.com/api/v1/faxes/fx_8Kj3... \
-H "Authorization: Bearer dds_YOUR_API_KEY"Can I search faxes and read extracted data?
Yes — inbound faxes are OCR'd, classified (referral, EOB, lab order, prescription, records request, and more), and key fields are extracted automatically. Search by full text, document type, or urgency:
curl "https://www.ddsfax.com/api/v1/faxes/search?type=referral&urgency=urgent" \
-H "Authorization: Bearer dds_YOUR_API_KEY"Or fetch the full intelligence result for one fax — classification, confidence, urgency, OCR quality, extracted fields, and named entities:
curl https://www.ddsfax.com/api/v1/faxes/fx_8Kj3.../intelligence \
-H "Authorization: Bearer dds_YOUR_API_KEY"Endpoint overview
| Endpoint | What it does |
|---|---|
POST /api/v1/faxes | Send a PDF to a fax number |
GET /api/v1/faxes | List faxes (direction, limit, offset) |
GET /api/v1/faxes/{id} | Status + metadata for one fax |
GET /api/v1/faxes/search | Full-text + doc-type + urgency search |
GET /api/v1/faxes/{id}/intelligence | AI classification, extraction, entities |
GET /api/v1/numbers | Search available fax numbers |
POST /api/v1/numbers | Provision a number |
Full request/response schemas live in the OpenAPI 3.1 spec.
Can my AI agent use DDSFAX? (MCP server)
Yes — DDSFAX ships a native MCP server (Model Context Protocol), so Claude, ChatGPT, and any MCP-compatible agent can send faxes, check delivery, search inbound documents, and read AI-extracted data directly. Connect with the Streamable HTTP transport:
URL: https://www.ddsfax.com/api/mcp
Header: Authorization: Bearer dds_YOUR_API_KEYSix tools are exposed: send_fax, lookup_provider_fax (NPPES-backed
provider fax resolution), get_fax_status, search_faxes, read_fax, and get_account_usage.
Sends require an idempotency key, every tool call is written to the HIPAA audit log, and the
machine-readable manifest lives at /.well-known/mcp.json.
MCP access requires an active DDSFAX Professional subscription — step-by-step setup guides
for Claude, ChatGPT, Cursor, and other clients live in the dashboard under AI Agents (MCP).
Is the API HIPAA compliant?
Yes. The API is the same HIPAA-controlled surface as the dashboard: every request is authenticated and audit-logged, documents are encrypted at rest with 256-bit AES, and a Business Associate Agreement is included with every account — sign it self-serve in minutes. Details on the HIPAA compliance and BAA pages.