# mintfax

## Docs

- [Let an AI agent send faxes on behalf of your users](https://mintfax.com/docs/ai-agents.md): Expose the mintfax API to LLM tool-use loops with structured errors and idempotency
- [Start Registration](https://mintfax.com/docs/api-reference/account/create-sandbox-account.md): Begins the account registration flow. Sends a 6-digit activation code to the provided email address. The code is valid for 15 minutes.
- [Get Account](https://mintfax.com/docs/api-reference/account/get-account.md): Returns account details and the current environment.
- [Get Balance](https://mintfax.com/docs/api-reference/account/get-balance.md): Returns available credits and credits currently held for in-flight faxes.
- [Get Default Fax Settings](https://mintfax.com/docs/api-reference/account/get-fax-settings.md): Returns the current default fax submission settings.
- [Update Default Fax Settings](https://mintfax.com/docs/api-reference/account/update-fax-settings.md): Set default fax submission parameters. These apply to all faxes unless overridden per submission.
- [Update Account Settings](https://mintfax.com/docs/api-reference/account/update-settings.md): Update account-level settings such as webhook URL, event subscriptions, and retention policy.
- [Verify Registration Code](https://mintfax.com/docs/api-reference/account/verify-registration.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.
- [Delete a Fax](https://mintfax.com/docs/api-reference/fax/delete-a-fax.md): Permanently deletes fax data (document, images, metadata). Billing records are retained. Only faxes in a terminal state (delivered or failed) can be deleted.
- [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.
- [List Faxes](https://mintfax.com/docs/api-reference/fax/list-faxes.md): Returns a paginated list of faxes for the authenticated environment, most recent first.
- [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.
- [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.
- [API Reference](https://mintfax.com/docs/api-reference/overview.md): Complete reference for the mintfax v1 API
- [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.
- [Delete Webhook Endpoint](https://mintfax.com/docs/api-reference/webhooks/delete-webhook-endpoint.md): Permanently removes a webhook endpoint.
- [List Webhook Endpoints](https://mintfax.com/docs/api-reference/webhooks/list-webhook-endpoints.md): Returns all webhook endpoints configured for the current environment.
- [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.
- [Update Webhook Endpoint](https://mintfax.com/docs/api-reference/webhooks/update-webhook-endpoint.md): Updates an existing webhook endpoint.
- [Authentication](https://mintfax.com/docs/authentication.md): API key authentication for sandbox and live environments
- [Build faxing into your SaaS product](https://mintfax.com/docs/build-into-saas.md): Multi-tenant patterns, credential management, and per-customer webhook routing
- [Status, changelog, and postmortems](https://mintfax.com/docs/changelog.md): Track mintfax service health, API changes, and incident reports.
- [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
- [How credits and billing work](https://mintfax.com/docs/credits.md): Prepaid credit system, hold lifecycle, and balance queries
- [Data Retention](https://mintfax.com/docs/data-retention.md): Control how long fax data is stored
- [Environments](https://mintfax.com/docs/environments.md): Sandbox and live environments for development and production
- [Understand error codes and what to do about them](https://mintfax.com/docs/errors.md): Error codes, HTTP statuses, causes, and recommended actions
- [Events](https://mintfax.com/docs/events.md): Event types, payload shapes, and delivery behavior for mintfax webhooks
- [FAQ](https://mintfax.com/docs/faq.md): Answers to the questions developers ask most often about the mintfax API
- [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
- [Glossary](https://mintfax.com/docs/glossary.md): Definitions of fax protocol, telephony, compliance, and API terms used in mintfax documentation.
- [Go live with confidence](https://mintfax.com/docs/go-live.md): Production readiness checklist for switching from sandbox to live
- [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.
- [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
- [Retry safely without sending duplicate faxes](https://mintfax.com/docs/idempotency.md): Idempotency keys, retry logic, and exponential backoff
- [Introduction](https://mintfax.com/docs/index.md): Developer-first fax API with compliance, security, and reliability built in
- [Send faxes to any country](https://mintfax.com/docs/international.md): E.164 formatting, country-specific dial rules, and destination support
- [Switch to live and start sending real faxes](https://mintfax.com/docs/live.md): Activate your live environment and understand what changes from sandbox
- [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 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
- [PCI-DSS and cardholder data](https://mintfax.com/docs/pci-dss.md): How mintfax handles fax documents containing payment card information
- [Quickstart](https://mintfax.com/docs/quickstart.md): Create a sandbox account and send your first test fax
- [Handle throttling and plan around request limits](https://mintfax.com/docs/rate-limits.md): Per-workspace rate limits, response headers, and retry strategies
- [Test without sending real faxes](https://mintfax.com/docs/sandbox.md): Magic numbers, simulated outcomes, and balance testing for integration development
- [Handle time-sensitive documents](https://mintfax.com/docs/time-sensitive.md): Optimize delivery speed, monitor for failures, and plan fallbacks for urgent faxes
- [Track whether a fax was delivered](https://mintfax.com/docs/track-delivery.md): Check fax status by polling the API or receiving webhook events
- [Diagnose common failures](https://mintfax.com/docs/troubleshooting.md): Symptom-to-fix matrix for common mintfax issues
- [Verify that webhook payloads came from mintfax](https://mintfax.com/docs/webhook-signing.md): HMAC-SHA256 signature verification with code samples in five languages
- [Get notified when a fax is delivered or fails](https://mintfax.com/docs/webhooks.md): Real-time status updates pushed to your server via HTTP callbacks
- [Send faxes from Zapier](https://mintfax.com/docs/zapier.md): Connect mintfax to Zapier so a trigger in any app sends a fax automatically.

## OpenAPI Specs

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