# mintfax

## Docs

- [Introduction](https://mintfax.com/docs/index.md): Developer-first fax API with compliance, security, and reliability built in
- [Quickstart](https://mintfax.com/docs/quickstart.md): Create a sandbox account and send your first sandbox fax
- [AI agents](https://mintfax.com/docs/ai-agents.md): Reference page for AI coding agents integrating mintfax
- [Authentication](https://mintfax.com/docs/authentication.md): API key authentication for sandbox and live environments
- [Environments](https://mintfax.com/docs/environments.md): Sandbox and live environments for development and production
- [Sandbox](https://mintfax.com/docs/sandbox.md): Magic numbers, simulated outcomes, and balance testing for integration development
- [Sandbox scenarios](https://mintfax.com/docs/sandbox-scenarios.md): The canonical catalog of sandbox magic numbers and the outcomes they force.
- [Live](https://mintfax.com/docs/live.md): Real fax delivery, real credits, real recipients
- [How credits and billing work](https://mintfax.com/docs/credits.md): Account-pool credit model, hold lifecycle, and balance queries
- [Understand error codes and what to do about them](https://mintfax.com/docs/errors.md): Error codes, HTTP statuses, causes, and recommended actions
- [Handle throttling and plan around request limits](https://mintfax.com/docs/rate-limits.md): Per-environment rate limits, response headers, and retry strategies
- [Retry safely without sending duplicate faxes](https://mintfax.com/docs/idempotency.md): Idempotency keys, retry logic, and exponential backoff
- [Diagnose common failures](https://mintfax.com/docs/troubleshooting.md): Symptom-to-fix matrix for common mintfax issues
- [The mintfax fax API](https://mintfax.com/docs/fax-api.md): What the API does, what ships in the box at every paid tier, and where to go next
- [Control what the recipient sees first](https://mintfax.com/docs/cover-pages.md): Attach cover pages, personalize with tokens, and use the HIPAA-compliant variant
- [Send faxes to any country](https://mintfax.com/docs/international.md): E.164 formatting, country-specific dial rules, and destination support
- [Handle time-sensitive documents](https://mintfax.com/docs/time-sensitive.md): Optimize delivery speed, monitor for failures, and plan fallbacks for urgent faxes
- [Know what file types and sizes you can send](https://mintfax.com/docs/file-types.md): Supported formats, size limits, and what happens when a file can't be converted
- [Track whether a fax was delivered](https://mintfax.com/docs/track-delivery.md): Check fax status by polling the API or receiving webhook events
- [Go live with confidence](https://mintfax.com/docs/go-live.md): Production readiness checklist for switching from sandbox to live
- [Send faxes containing patient health information](https://mintfax.com/docs/patient-health-info.md): Set up HIPAA-compliant faxing with a BAA, retention controls, and audit logging
- [Node.js quickstart](https://mintfax.com/docs/node.md): Send your first fax with Node.js, check its status, and verify a webhook signature.
- [Send faxes from Zapier](https://mintfax.com/docs/zapier.md): Connect mintfax to Zapier so a trigger in any app sends a fax automatically.
- [Build faxing into your SaaS product](https://mintfax.com/docs/build-into-saas.md): Multi-tenant patterns, credential management, and per-customer webhook routing
- [Migrate from Sinch Fax v3 (or Phaxio v2.1) to mintfax](https://mintfax.com/docs/migrate-sinch.md): Endpoint, auth, payload, webhook, and error mapping with curl and Node samples. Walks through what changes and what to verify before you cut over.
- [Migrate from Telnyx Programmable Fax to mintfax](https://mintfax.com/docs/migrate-telnyx.md): Endpoint mapping, auth swap, webhook diff, retry-loop removal, and a pricing translation for engineers moving off Telnyx.
- [Migrate from Documo / mFax to mintfax](https://mintfax.com/docs/migrate-documo.md): Endpoint mapping, authentication swap, webhook signing change, and rollback plan for engineers porting an integration off Documo's v1 API.
- [Migrate from eFax Developer / Consensus](https://mintfax.com/docs/migrate-efax.md): Map eFax Universal Outbound (XML) and eFax Enterprise API (REST) onto mintfax. Auth swap, endpoint table, error translation, Standard Webhooks signing, sandbox verification.
- [FAQ](https://mintfax.com/docs/faq.md): Answers to the questions developers ask most often about the mintfax API
- [Glossary](https://mintfax.com/docs/glossary.md): Definitions of fax protocol, telephony, compliance, and API terms used in mintfax documentation.
- [HIPAA compliance](https://mintfax.com/docs/hipaa.md): BAA signing, audit logging, encryption, retention controls, and compliance boundary disclosure for fax workloads that handle PHI.
- [PCI-DSS and cardholder data](https://mintfax.com/docs/pci-dss.md): How mintfax handles fax documents containing payment card information
- [Data Retention](https://mintfax.com/docs/data-retention.md): Control how long fax data is stored
- [Status, changelog, and postmortems](https://mintfax.com/docs/changelog.md): Track mintfax service health, API changes, and incident reports.
- [How fax works](https://mintfax.com/docs/how-fax-works.md): The fax protocol lifecycle from call setup to page delivery, and how it maps to the mintfax API
- [Receive fax events with webhooks](https://mintfax.com/docs/webhooks/index.md): Subscribe to fax lifecycle and balance events. Real-time delivery, signed payloads, and replayable history.
- [Verify webhook signatures](https://mintfax.com/docs/webhooks/verify-requests.md): Confirm that an incoming webhook request was sent by mintfax. Standard Webhooks spec, HMAC-SHA256, reference libraries in eight languages.
- [Webhook delivery and retries](https://mintfax.com/docs/webhooks/delivery-and-retries.md): How mintfax delivers events, what triggers a retry, and how to make your handler safe to call more than once.
- [Debug webhook deliveries](https://mintfax.com/docs/webhooks/inspect-attempts.md): Find a specific delivery attempt, see what mintfax sent, what your endpoint replied, and replay the request after a fix.
- [Event types](https://mintfax.com/docs/webhooks/events/overview.md): Every event mintfax can send, when each fires, and the payload structure shared across the catalog.
- [fax.queued](https://mintfax.com/docs/webhooks/events/fax-queued.md): Sent when a fax has been accepted and is queued for delivery.
- [fax.sending](https://mintfax.com/docs/webhooks/events/fax-sending.md): Sent when a delivery attempt against the destination begins.
- [fax.delivered](https://mintfax.com/docs/webhooks/events/fax-delivered.md): Sent when a fax has been successfully delivered.
- [fax.failed](https://mintfax.com/docs/webhooks/events/fax-failed.md): Sent when a fax has failed terminally.
- [balance.low](https://mintfax.com/docs/webhooks/events/balance-low.md): Sent when an environment's available balance crosses below the low-balance threshold.
- [balance.topup](https://mintfax.com/docs/webhooks/events/balance-topup.md): Sent when funds are added to an environment.
- [Overview](https://mintfax.com/docs/api-reference/overview.md): Complete reference for the mintfax v1 API
- [Start Registration](https://mintfax.com/docs/api-reference/account/start-registration.md): Begins the account registration flow. Sends a 6-digit activation code to the provided email address. The code is valid for 15 minutes.
- [Verify Registration Code](https://mintfax.com/docs/api-reference/account/verify-registration-code.md): Completes registration by verifying the activation code sent to the provided email. On success, creates the account, user, sandbox environment, and API key in a single transaction.
- [Get Account](https://mintfax.com/docs/api-reference/account/get-account.md): Returns account details. Requires an account-scoped key (`mfx_acct_...`).
- [Get Account Balances](https://mintfax.com/docs/api-reference/account/get-account-balances.md): Returns balances for all credit pools (sandbox and live) on the account. Requires an account-scoped key (`mfx_acct_...`).
- [Get Account Transactions](https://mintfax.com/docs/api-reference/account/get-account-transactions.md): Returns credit transactions across all pools for the account. Optionally filter by `type` query param (`live` or `sandbox`). Requires an account-scoped key (`mfx_acct_...`).
- [List API Keys](https://mintfax.com/docs/api-reference/account/list-api-keys.md): Returns all API keys on the account. Requires an account-scoped key (`mfx_acct_...`).
- [Create API Key](https://mintfax.com/docs/api-reference/account/create-api-key.md): Creates a new environment-scoped API key (test or live). Account-scoped keys can only be created via the dashboard. Requires an account-scoped key (`mfx_acct_...`).
- [Delete API Key](https://mintfax.com/docs/api-reference/account/delete-api-key.md): Permanently revokes and deletes an API key. Account-scoped keys can only be deleted via the dashboard. Requires an account-scoped key (`mfx_acct_...`).
- [Get Environment](https://mintfax.com/docs/api-reference/environment/get-environment.md): Returns details for the environment the caller's key is scoped to. Requires an environment key (`mfx_test_...` or `mfx_live_...`).
- [Get Environment Balance](https://mintfax.com/docs/api-reference/environment/get-environment-balance.md): Returns the account credit balance for the pool matching the caller's environment mode (sandbox or live). The pool is shared across all environments of the same mode - this endpoint exists so environment keys can read "what can I spend?" without needing an account key. For both pools at once, use `G…
- [Get Environment Transactions](https://mintfax.com/docs/api-reference/environment/get-environment-transactions.md): Returns credit transactions for the environment the caller's key is scoped to. Requires an environment key (`mfx_test_...` or `mfx_live_...`).
- [Get Default Fax Settings](https://mintfax.com/docs/api-reference/environment/get-default-fax-settings.md): Returns the current default fax submission settings for the environment. Requires an environment key (`mfx_test_...` or `mfx_live_...`).
- [Update Default Fax Settings](https://mintfax.com/docs/api-reference/environment/update-default-fax-settings.md): Set default fax submission parameters for the environment. These apply to all faxes unless overridden per submission. Requires an environment key (`mfx_test_...` or `mfx_live_...`).
- [Send a Fax](https://mintfax.com/docs/api-reference/fax/send-a-fax.md): Submit a fax for delivery. The file is staged and the fax is queued for processing. A credit hold is placed on submission and captured on delivery or released on failure.
- [List Faxes](https://mintfax.com/docs/api-reference/fax/list-faxes.md): Returns a cursor-paginated list of faxes, most recent first. Defaults to the last 7 days; pass explicit `created_after` and `created_before` to widen or narrow the window.
- [Get a Fax](https://mintfax.com/docs/api-reference/fax/get-a-fax.md): Returns the full fax record including status, error details, and timing.
- [Get Fax Image](https://mintfax.com/docs/api-reference/fax/get-fax-image.md): Returns the rendered fax image (TIFF). Only available for faxes that have been processed and are within the retention period.
- [Resend a Fax](https://mintfax.com/docs/api-reference/fax/resend-a-fax.md): Resubmits a previously failed or delivered fax using the original document. A new credit hold is placed. Returns the new fax record.
- [Purge a Fax](https://mintfax.com/docs/api-reference/fax/purge-a-fax.md): Scrubs fax content and PII (document, destination number, idempotency key, webhook URL, error message) and removes the stored image. The fax record itself is retained so billing and audit history stay intact; subsequent `GET /faxes/{id}` calls continue to succeed and return the scrubbed record. Only…
- [List Events](https://mintfax.com/docs/api-reference/events/list-events.md): Returns events for the authenticated environment, newest first. Supports cursor pagination.
- [Retrieve an Event](https://mintfax.com/docs/api-reference/events/retrieve-an-event.md)
- [List Webhook Endpoints](https://mintfax.com/docs/api-reference/webhooks/list-webhook-endpoints.md): Returns all webhook endpoints configured for the current environment.
- [Create Webhook Endpoint](https://mintfax.com/docs/api-reference/webhooks/create-webhook-endpoint.md): Creates a new webhook endpoint. Returns the endpoint and its signing secret. The signing secret is only shown once - store it securely.
- [Update Webhook Endpoint](https://mintfax.com/docs/api-reference/webhooks/update-webhook-endpoint.md): Updates an existing webhook endpoint.
- [Delete Webhook Endpoint](https://mintfax.com/docs/api-reference/webhooks/delete-webhook-endpoint.md): Permanently removes a webhook endpoint.
- [Rotate Signing Secret](https://mintfax.com/docs/api-reference/webhooks/rotate-signing-secret.md): Generates a new signing secret for the endpoint. The previous secret is immediately invalidated. The new secret is only shown once.
- [List Webhook Delivery Attempts](https://mintfax.com/docs/api-reference/webhooks/list-webhook-delivery-attempts.md): Returns webhook delivery attempts for the authenticated environment, newest first. Supports cursor pagination and filtering by endpoint, fax, or attempt outcome.
- [Retrieve a Webhook Attempt](https://mintfax.com/docs/api-reference/webhooks/retrieve-a-webhook-attempt.md)
- [Retry a Webhook Delivery](https://mintfax.com/docs/api-reference/webhooks/retry-a-webhook-delivery.md): Re-dispatches the original Event payload to the webhook endpoint. Allowed regardless of the original attempt's outcome. The new attempt row carries `parent_attempt_id` pointing to the original.

## OpenAPI Specs

- [openapi](https://mintfax.com/docs/openapi.json)