> ## 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.

# Introduction

> Developer-first fax API with compliance, security, and reliability built in

mintfax is a fax API that handles the infrastructure so you don't have to deal with it directly. Send a fax with a single `curl` POST. Get delivery status via polling or webhooks. Handle compliance with built-in retention policies and zero-footprint mode.

## Why mintfax

* **Self-serve signup** - create a sandbox account, get an API key, and send a sandbox fax in under a minute. No sales calls, no manual provisioning.
* **For agent callers** - OpenAPI spec, structured error responses with action hints, and deterministic sandbox flows.
* **Compliance built in** - Encryption at rest and in transit. Exportable audit log. Configurable retention. Zero-footprint mode: fax data deleted after delivery.

## Quick Links

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/docs/quickstart">
    Send your first sandbox fax in 60 seconds
  </Card>

  <Card title="API Reference" icon="code" href="/docs/api-reference/overview">
    Full endpoint documentation
  </Card>

  <Card title="Error Catalog" icon="triangle-exclamation" href="/docs/errors">
    Every error code and what to do about it
  </Card>

  <Card title="Webhooks" icon="bell" href="/docs/webhooks">
    Real-time delivery notifications
  </Card>
</CardGroup>

## How It Works

1. **Create an account** - `POST /account/register` + verify email code to get your API key
2. **Send a fax** - `POST /fax` with a file attachment queues the fax
3. **Track delivery** - poll `GET /fax/{id}` or receive a webhook
4. **Credits** - prepaid balance with hold-on-submit, capture-on-delivery, release-on-failure

A credit hold is placed when you submit a fax. If delivery succeeds, the hold is captured as a charge. If delivery permanently fails, the hold is released back to your balance. You are never charged for failed deliveries.