Fax Management

The Fax API allows you to send and receive fax documents. Send documents from your application, receive incoming faxes, and track fax status and delivery.

Base URL

https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/faxes

Authentication

All requests require the X-Auth-Token header:

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/faxes" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

List Faxes

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/faxes?paginate=false" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Response

{
  "auth_token": "eyJhbGciOiJSUzI1...",
  "data": [
    {
      "id": "fax_abc123",
      "direction": "outbound",
      "from_number": "+14155552671",
      "to_number": "+14155559999",
      "status": "sent",
      "pages": 3,
      "timestamp": "2026-02-04T10:30:00Z"
    }
  ],
  "request_id": "req_xyz789",
  "status": "success"
}

Send Fax

Using Document URL

curl -X PUT "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/faxes" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "from_number": "+14155552671",
      "to_number": "+14155559999",
      "document_url": "https://example.com/document.pdf"
    }
  }'

Using Document Upload

curl -X PUT "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/faxes" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: multipart/form-data" \
  -F "to_number=+14155559999" \
  -F "from_number=+14155552671" \
  -F "document=@/path/to/document.pdf"

Get Fax Details

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/faxes/{FAX_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Download Fax Document

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/faxes/{FAX_ID}/attachment" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/pdf" \
  --output fax_document.pdf

Delete Fax

curl -X DELETE "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/faxes/{FAX_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}"

Fax Fields

Field	Type	Description
id	string	Unique fax identifier
direction	string	inbound or outbound
from_number	string	Sender fax number
to_number	string	Recipient fax number
status	string	Current fax status
pages	integer	Number of pages
timestamp	string	Send/receive time
document_url	string	URL to fax document

Fax Status

Status	Description
pending	Fax queued for sending
processing	Fax being processed
sending	Fax transmission in progress
sent	Fax successfully delivered
failed	Fax transmission failed
received	Inbound fax received

Supported Formats

Format	Extension	Description
PDF	.pdf	Best compatibility
TIFF	.tiff	High-quality, archival
PNG	.png	Graphics, charts
JPG	.jpg	Photographs

Fax Inbox (Inbound)

List received faxes:

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/faxes/inbox" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Fax Outbox (Outbound)

List sent faxes:

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/faxes/outbox" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Best Practices

1. Format Selection: Use PDF for best compatibility
2. File Size: Compress large documents before sending
3. Number Validation: Verify fax numbers before sending
4. Status Monitoring: Poll for delivery status
5. Retries: Implement retry logic for failed faxes

Topics

• Send Fax - Transmit documents
• Receive Fax - Handle inbound faxes
• Fax Status - Track delivery