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.

mintfax has two environment types: sandbox and live. When you create an account, one of each is set up automatically. You can create additional environments of either type to manage activity separately - for example, separate live environments for staging and production, or per-client sandbox environments for integration testing. Each environment is an isolated container with its own API keys, fax history, balance, and settings. Data never crosses between them.

​
How Routing Works

The API key prefix determines which environment handles the request. There is no separate base URL or environment toggle.
PrefixEnvironmentEffect
fx_test_SandboxRouted to sandbox. No real faxes sent.
fx_live_LiveRouted to production. Real faxes delivered.
See Authentication for key management and rotation.

​
What’s Isolated

Each environment has its own:
  • API keys - a key belongs to exactly one environment
  • Fax records - sandbox faxes never appear in live queries, and vice versa
  • Balance and credits - each environment has its own prepaid balance with independent hold/capture/release. Credits are not shared or poolable between environments.
  • Webhook endpoints - delivery notifications are scoped per environment
  • Fax settings - cover page defaults, retry policy, and other configuration

​
No Migration Path

Environments are deliberately isolated. There is no way to migrate data, settings, or history from sandbox to live. This prevents test data from contaminating production.
When you activate your live environment, configure it independently from scratch. Settings portability via export/import may be added in the future.

​
Created on Registration

When you register, both environments are created automatically. Your first API key is a sandbox key (fx_test_), so you can start sending test faxes immediately. The sandbox environment comes with a dummy credit balance. Your live environment is ready but inactive until you add a payment method in the dashboard. Once activated, you can generate fx_live_ keys and send real faxes.

​
Next

Sandbox

Test numbers, simulated outcomes, and balance testing

Live

Real fax delivery and production behavior