Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintfax.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks through creating a sandbox account and sending a test fax. Every step is a single curl command with a predictable response.

​
Step 1: Register

curl -X POST https://api.mintfax.com/v1/account/register \
  -H "Content-Type: application/json" \
  -d '{"name": "Test Account", "email": "dev@example.com"}'
Response: 
{
  "email": "dev@example.com",
  "message": "Activation code sent. Valid for 15 minutes.",
  "expires_in": 900
}
Check your email for a 6-digit activation code.

​
Step 2: Verify and Get Your API Key

curl -X POST https://api.mintfax.com/v1/account/register/verify \
  -H "Content-Type: application/json" \
  -d '{"email": "dev@example.com", "code": "482901"}'
Response: 
{
  "account": { "id": "a1b2c3d4-...", "name": "Test Account" },
  "user": { "id": "u9a8b7c6-...", "email": "dev@example.com" },
  "environment": { "id": "w1x2y3z4-...", "name": "Sandbox", "type": "sandbox" },
  "api_key": "fx_test_abc123def456..."
}
Save the api_key value. It is only shown once.

​
Step 3: Send a Test Fax

Use a sandbox test number. Sandbox faxes are not delivered to real fax machines. 
curl -X POST https://api.mintfax.com/v1/fax \
  -H "Authorization: Bearer fx_test_abc123def456..." \
  -F "to=+15551000001" \
  -F "file=@document.pdf"
Response: 
{
  "id": "9c1a2b3d-4e5f-6789-abcd-ef0123456789",
  "status": "queued",
  "to": "+15551000001",
  "created_at": "2026-01-15T10:30:00Z"
}
Save the fax id for the next step.

​
Step 4: Check Fax Status

curl https://api.mintfax.com/v1/fax/9c1a2b3d-4e5f-6789-abcd-ef0123456789 \
  -H "Authorization: Bearer fx_test_abc123def456..."
Response (after processing): 
{
  "id": "9c1a2b3d-4e5f-6789-abcd-ef0123456789",
  "status": "delivered",
  "to": "+15551000001",
  "pages": 1,
  "retries_remaining": 3,
  "submitted_at": "2026-01-15T10:30:01Z",
  "completed_at": "2026-01-15T10:30:05Z",
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:05Z"
}
In sandbox mode, test numbers resolve to simulated outcomes within seconds.

​
Step 5: Check Balance

curl https://api.mintfax.com/v1/account/balance \
  -H "Authorization: Bearer fx_test_abc123def456..."
Response: 
{
  "available": 99.94,
  "held": 0.00
}
Sandbox accounts start with a dummy balance. Each test fax deducts credits just like production, so you can test balance-related flows (insufficient funds, low balance warnings).

​
Next Steps