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 key as Bearer token. Use an account key (mfx_acct_...) for
/account/* endpoints, and an environment key (mfx_test_... for
sandbox, mfx_live_... for live) for /environment/*, /faxes,
/webhooks, and /events.
Client-generated key for idempotent submission (recommended). Duplicate keys return the original response without re-processing. Keys expire after 24 hours.
Original fax identifier when this submission is a resend; only present on resends.
Example:
"fax_8aZqRm4yT3vK7pNxJ2bH9c"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"mintfax","colors":{"primary":"#16a34a","light":"#4ade80","dark":"#15803d"},"logo":{"light":"https://mintcdn.com/mintfax/zOe7HYdESMHdd_OE/logo/light.svg?fit=max\u0026auto=format\u0026n=zOe7HYdESMHdd_OE\u0026q=85\u0026s=765735134c5677c7b3bd07cb4a59b7a2","dark":"https://mintcdn.com/mintfax/zOe7HYdESMHdd_OE/logo/dark.svg?fit=max\u0026auto=format\u0026n=zOe7HYdESMHdd_OE\u0026q=85\u0026s=74f5aa178eb1e3f0e7bc6000838e6694","href":"https://mintfax.com/"},"favicon":"https://mintcdn.com/mintfax/GiBvlLI3STLcxoyN/favicon.svg?fit=max\u0026auto=format\u0026n=GiBvlLI3STLcxoyN\u0026q=85\u0026s=d469838ec65481af2598399f79262581","api":{"openapi":"openapi.json","mdx":{"auth":{"method":"bearer"},"server":"https://api.mintfax.com/v1"}},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://mintfax.com/dashboard","label":"Dashboard"}],"primary":{"type":"button","label":"Get API Key","href":"https://mintfax.com/register"}},"seo":{"metatags":{"canonical":"https://mintfax.com/docs"}},"fonts":{"heading":{"family":"Red Hat Display","weight":900}},"contextual":{"options":["copy","view"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mintfax","hasAudioNarration":false,"actualSubdomain":"mintfax","customDomains":["mintfax.com"],"gitSource":{"type":"github","owner":"mintfax","repo":"mintfax-content","deployBranch":"main","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aec645afc016830a858293d","collectionId":"08729f9d-2219-40df-8d35-ad7b5333d2f7","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec645afc016830a858293d"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aec645afc016830a858293d","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":31},{"language":"default","tag":"Webhooks","count":20},{"language":"default","tag":"Guides","count":17},{"language":"default","tag":"Docs","count":13},{"language":"default","tag":"Get Started","count":9},{"language":"default","tag":"Account","count":8},{"language":"default","tag":"Resources","count":7},{"language":"default","tag":"Event types","count":7},{"language":"default","tag":"Fax","count":6},{"language":"default","tag":"Migration","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/fax/send-a-fax","slug":"/api-reference/fax/send-a-fax","pageMetadata":{"title":"Send a Fax","description":"Submit a fax for delivery. The file is staged and the fax is queued for processing.\nA credit hold is placed on submission and captured on delivery or released on failure.","deprecated":null,"version":null,"openapi":"/openapi.json post /faxes","href":"/api-reference/fax/send-a-fax","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Submit a fax for delivery. The file is staged and the fax is queued for processing.\\nA credit hold is placed on submission and captured on delivery or released on failure.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Send a Fax","description":"Submit a fax for delivery. The file is staged and the fax is queued for processing.\nA credit hold is placed on submission and captured on delivery or released on failure.","deprecated":null,"version":null,"openapi":"/openapi.json post /faxes","href":"/api-reference/fax/send-a-fax","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/mintfax/b2ee2cec7900d37c/openpanel.js"],"openApiReferenceData":{"operation":{"operationId":"sendFax","description":"Submit a fax for delivery. The file is staged and the fax is queued for processing.\nA credit hold is placed on submission and captured on delivery or released on failure.","summary":"Send a Fax","tags":["Fax"],"parameters":["eee9eab4-9d6d-49f9-8bc6-252425bd92e9"],"requestBody":"c5f79000-ecf5-49aa-8427-99d850d566b1","responses":{"201":"9b318654-1b75-43ad-8f91-da5a6f724ff1","401":"72fa18c5-4e6a-4645-bb69-deb814584b82","402":"98af984c-42c9-4487-87e4-0f9d6d004086","403":"d7d1c71d-348e-4257-b746-a9ae74b8d6e3","422":"3f04ad8b-6ba1-4c44-acd7-406842271910","500":"d7a5f839-810c-48a9-857c-baf065804262"},"method":"post","type":"path","servers":["ab1cf113-af3d-4bc9-87ee-4d384d780727"],"security":["e9f63b88-aadd-44b6-b8d4-417ed03ae72d"],"path":"/faxes","baseUrlOptions":["https://api.mintfax.com/v1"],"title":"Send a Fax","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"eee9eab4-9d6d-49f9-8bc6-252425bd92e9":{"name":"Idempotency-Key","in":"header","description":"Client-generated key for idempotent submission (recommended). Duplicate keys return the original response without re-processing. Keys expire after 24 hours.","schema":{"type":"string","description":"Client-generated key for idempotent submission (recommended). Duplicate keys return the original response without re-processing. Keys expire after 24 hours.","uniqueKey":"","typeLabel":"string"},"example":"order-1234-attempt-1"}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"to":{"type":"string","pattern":"^\\+[1-9]\\d{1,14}$","isRequired":true,"uniqueKey":"to","typeLabel":"string"},"file":{"type":"string","format":"binary","contentMediaType":"application/octet-stream","maxLength":10240,"isRequired":true,"uniqueKey":"file","typeLabel":"file"},"webhook_url":{"oneOf":[{"type":"string","format":"uri","maxLength":2048,"uniqueKey":"webhook_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","maxLength":2048,"uniqueKey":"webhook_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_url","typeLabel":"string\u003curi> | null"},"max_attempts":{"oneOf":[{"type":"integer","minimum":1,"maximum":5,"uniqueKey":"max_attempts.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":5,"uniqueKey":"max_attempts.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_attempts","typeLabel":"integer | null"},"csid":{"oneOf":[{"type":"string","maxLength":20,"uniqueKey":"csid.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":20,"uniqueKey":"csid.oneOf.1","typeLabel":"null"}],"uniqueKey":"csid","typeLabel":"string | null"},"page_size":{"oneOf":[{"type":"string","enum":["letter","legal","a4","b4"],"uniqueKey":"page_size.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["letter","legal","a4","b4"],"uniqueKey":"page_size.oneOf.1","typeLabel":"null"}],"uniqueKey":"page_size","typeLabel":"enum\u003cstring> | null"},"resolution":{"oneOf":[{"type":"string","enum":["standard","fine"],"uniqueKey":"resolution.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["standard","fine"],"uniqueKey":"resolution.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolution","typeLabel":"enum\u003cstring> | null"},"optimize_for":{"oneOf":[{"type":"string","enum":["text","photo"],"uniqueKey":"optimize_for.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["text","photo"],"uniqueKey":"optimize_for.oneOf.1","typeLabel":"null"}],"uniqueKey":"optimize_for","typeLabel":"enum\u003cstring> | null"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":255,"uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":10,"uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","maxLength":255},"maxItems":10,"uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"}},"required":["to","file"],"title":"SubmitFaxRequest","uniqueKey":"","typeLabel":"SubmitFaxRequest · object"},"examples":{"Example":{"title":"Example","value":{"to":"\u003cstring>","file":"\u003cstring>","webhook_url":"\u003cstring>","max_attempts":3,"csid":"\u003cstring>","tags":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9b318654-1b75-43ad-8f91-da5a6f724ff1":{"description":"`FaxSubmissionResource`","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique fax identifier (fax_-prefixed).","examples":["fax_8aZqRm4yT3vK7pNxJ2bH9c"],"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","enum":["queued","submitted","in_progress","delivered","failed"],"title":"FaxStatus","description":"Initial fax status.","examples":["queued"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"to":{"oneOf":[{"type":"string","description":"Destination fax number in E.164 format.","examples":["+12125551234"],"isRequired":true,"uniqueKey":"to.oneOf.0","typeLabel":"string"},{"type":"null","description":"Destination fax number in E.164 format.","examples":["+12125551234"],"isRequired":true,"uniqueKey":"to.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"to","typeLabel":"string | null"},"tags":{"type":"object","description":"Echo of caller-supplied metadata. Empty serializes as `{}`.","additionalProperties":{"type":"string","uniqueKey":"tags.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"tags","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","description":"UTC timestamp when the fax record was created.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"resent_from":{"type":"string","description":"Original fax identifier when this submission is a resend; only present on resends.","examples":["fax_8aZqRm4yT3vK7pNxJ2bH9c"],"uniqueKey":"resent_from","typeLabel":"string"}},"required":["id","status","to","tags","created_at"],"title":"FaxSubmissionResource","uniqueKey":"","typeLabel":"FaxSubmissionResource · object"},"examples":{"Example":{"title":"Example","value":{"id":"fax_8aZqRm4yT3vK7pNxJ2bH9c","status":"queued","to":"+12125551234","tags":{},"created_at":"2023-11-07T05:31:56Z","resent_from":"fax_8aZqRm4yT3vK7pNxJ2bH9c"}}},"exampleType":"generated"}},"headers":{"X-Idempotency-Key":{"description":"Echoed back when the request supplied an `Idempotency-Key` header. Absent when the client omitted the request header.","required":false,"schema":{"type":"string"},"example":"order-1234-attempt-1"},"Idempotency-Replayed":{"description":"Set to `true` when this response was served from the idempotency cache rather than re-processing the request. Absent (not `false`) when the response represents a freshly processed submission.","required":false,"schema":{"type":"string"},"example":"true"}},"exampleType":"generated"},"72fa18c5-4e6a-4645-bb69-deb814584b82":{"description":"The provided API key is not recognised.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code.","example":"insufficient_balance","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","example":"Insufficient balance for this operation.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"action":{"type":"string","description":"Suggested next step for the caller.","example":"top_up_balance","isRequired":true,"uniqueKey":"action","typeLabel":"string"},"docs":{"type":"string","format":"uri","description":"URL to the docs entry for this error code.","example":"https://mintfax.com/docs/errors/insufficient-balance","isRequired":true,"uniqueKey":"docs","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique identifier for this API request, also returned in the X-Request-Id response header. Include this value in support requests for fast triage.","pattern":"^req_[0-9A-HJKMNP-TV-Z]{26}$","example":"req_01J9XYZQ8KH7B3R0WXAZP8VW6F","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"context":{"type":"object","description":"Error-specific extra fields (e.g. balances, validation errors).","additionalProperties":{"oneOf":[{}],"uniqueKey":"context.additionalProperties","typeLabel":"any"},"uniqueKey":"context","typeLabel":"object"}},"required":["error","message","action","docs","request_id"],"title":"Error","uniqueKey":"","typeLabel":"Error · object"},"examples":{"api_key_invalid":{"title":"api_key_invalid","value":{"error":"api_key_invalid","message":"The provided API key is not recognised.","action":"check_credentials","docs":"https://mintfax.com/docs/errors/api-key-invalid"}}},"exampleType":"examples"}},"exampleType":"examples"},"98af984c-42c9-4487-87e4-0f9d6d004086":{"description":"Insufficient balance for this operation.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code.","example":"insufficient_balance","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","example":"Insufficient balance for this operation.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"action":{"type":"string","description":"Suggested next step for the caller.","example":"top_up_balance","isRequired":true,"uniqueKey":"action","typeLabel":"string"},"docs":{"type":"string","format":"uri","description":"URL to the docs entry for this error code.","example":"https://mintfax.com/docs/errors/insufficient-balance","isRequired":true,"uniqueKey":"docs","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique identifier for this API request, also returned in the X-Request-Id response header. Include this value in support requests for fast triage.","pattern":"^req_[0-9A-HJKMNP-TV-Z]{26}$","example":"req_01J9XYZQ8KH7B3R0WXAZP8VW6F","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"context":{"type":"object","description":"Error-specific extra fields (e.g. balances, validation errors).","additionalProperties":{"oneOf":[{}],"uniqueKey":"context.additionalProperties","typeLabel":"any"},"uniqueKey":"context","typeLabel":"object"}},"required":["error","message","action","docs","request_id"],"title":"Error","uniqueKey":"","typeLabel":"Error · object"},"examples":{"insufficient_balance":{"title":"insufficient_balance","value":{"error":"insufficient_balance","message":"Insufficient balance for this operation.","action":"top_up_balance","docs":"https://mintfax.com/docs/errors/insufficient-balance","context":{"available":50,"required":100}}}},"exampleType":"examples"}},"exampleType":"examples"},"d7d1c71d-348e-4257-b746-a9ae74b8d6e3":{"description":"Live calls require account activation. Complete a first credit purchase to activate.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code.","example":"insufficient_balance","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","example":"Insufficient balance for this operation.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"action":{"type":"string","description":"Suggested next step for the caller.","example":"top_up_balance","isRequired":true,"uniqueKey":"action","typeLabel":"string"},"docs":{"type":"string","format":"uri","description":"URL to the docs entry for this error code.","example":"https://mintfax.com/docs/errors/insufficient-balance","isRequired":true,"uniqueKey":"docs","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique identifier for this API request, also returned in the X-Request-Id response header. Include this value in support requests for fast triage.","pattern":"^req_[0-9A-HJKMNP-TV-Z]{26}$","example":"req_01J9XYZQ8KH7B3R0WXAZP8VW6F","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"context":{"type":"object","description":"Error-specific extra fields (e.g. balances, validation errors).","additionalProperties":{"oneOf":[{}],"uniqueKey":"context.additionalProperties","typeLabel":"any"},"uniqueKey":"context","typeLabel":"object"}},"required":["error","message","action","docs","request_id"],"title":"Error","uniqueKey":"","typeLabel":"Error · object"},"examples":{"account_not_activated":{"title":"account_not_activated","value":{"error":"account_not_activated","message":"Live calls require account activation. Complete a first credit purchase to activate.","action":"activate_account","docs":"https://mintfax.com/docs/errors/account-not-activated"}},"key_not_scoped_for_operations":{"title":"key_not_scoped_for_operations","value":{"error":"key_not_scoped_for_operations","message":"This API key cannot send faxes or read environment data. Use an mfx_test_ or mfx_live_ key.","action":"use_operational_key","docs":"https://mintfax.com/docs/errors/key-not-scoped-for-operations"}}},"exampleType":"examples"}},"exampleType":"examples"},"3f04ad8b-6ba1-4c44-acd7-406842271910":{"description":"The request failed validation.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code.","example":"insufficient_balance","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","example":"Insufficient balance for this operation.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"action":{"type":"string","description":"Suggested next step for the caller.","example":"top_up_balance","isRequired":true,"uniqueKey":"action","typeLabel":"string"},"docs":{"type":"string","format":"uri","description":"URL to the docs entry for this error code.","example":"https://mintfax.com/docs/errors/insufficient-balance","isRequired":true,"uniqueKey":"docs","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique identifier for this API request, also returned in the X-Request-Id response header. Include this value in support requests for fast triage.","pattern":"^req_[0-9A-HJKMNP-TV-Z]{26}$","example":"req_01J9XYZQ8KH7B3R0WXAZP8VW6F","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"context":{"type":"object","description":"Error-specific extra fields (e.g. balances, validation errors).","additionalProperties":{"oneOf":[{}],"uniqueKey":"context.additionalProperties","typeLabel":"any"},"uniqueKey":"context","typeLabel":"object"}},"required":["error","message","action","docs","request_id"],"title":"Error","uniqueKey":"","typeLabel":"Error · object"},"examples":{"validation_failed":{"title":"validation_failed","value":{"error":"validation_failed","message":"The request failed validation.","action":"fix_request","docs":"https://mintfax.com/docs/errors/validation-failed","context":{"errors":{"to":["The to field is required."],"file":["The file field is required."]}}}}},"exampleType":"examples"}},"exampleType":"examples"},"d7a5f839-810c-48a9-857c-baf065804262":{"description":"An unexpected error occurred. Please retry; if the problem persists, contact support.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code.","example":"insufficient_balance","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","example":"Insufficient balance for this operation.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"action":{"type":"string","description":"Suggested next step for the caller.","example":"top_up_balance","isRequired":true,"uniqueKey":"action","typeLabel":"string"},"docs":{"type":"string","format":"uri","description":"URL to the docs entry for this error code.","example":"https://mintfax.com/docs/errors/insufficient-balance","isRequired":true,"uniqueKey":"docs","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique identifier for this API request, also returned in the X-Request-Id response header. Include this value in support requests for fast triage.","pattern":"^req_[0-9A-HJKMNP-TV-Z]{26}$","example":"req_01J9XYZQ8KH7B3R0WXAZP8VW6F","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"context":{"type":"object","description":"Error-specific extra fields (e.g. balances, validation errors).","additionalProperties":{"oneOf":[{}],"uniqueKey":"context.additionalProperties","typeLabel":"any"},"uniqueKey":"context","typeLabel":"object"}},"required":["error","message","action","docs","request_id"],"title":"Error","uniqueKey":"","typeLabel":"Error · object"},"examples":{"internal_server_error":{"title":"internal_server_error","value":{"error":"internal_server_error","message":"An unexpected error occurred. Please retry; if the problem persists, contact support.","action":"retry_or_contact_support","docs":"https://mintfax.com/docs/errors/internal-server-error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e9f63b88-aadd-44b6-b8d4-417ed03ae72d":{"bearerAuth":{"type":"http","description":"API key as Bearer token. Use an account key (`mfx_acct_...`) for\n`/account/*` endpoints, and an environment key (`mfx_test_...` for\nsandbox, `mfx_live_...` for live) for `/environment/*`, `/faxes`,\n`/webhooks`, and `/events`.","scheme":"bearer","scopes":[]}}},"servers":{"ab1cf113-af3d-4bc9-87ee-4d384d780727":{"url":"https://api.mintfax.com/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"API key as Bearer token. Use an account key (`mfx_acct_...`) for\n`/account/*` endpoints, and an environment key (`mfx_test_...` for\nsandbox, `mfx_live_...` for live) for `/environment/*`, `/faxes`,\n`/webhooks`, and `/events`.","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key as Bearer token. Use an account key (`mfx_acct_...`) for\n`/account/*` endpoints, and an environment key (`mfx_test_...` for\nsandbox, `mfx_live_...` for live) for `/environment/*`, `/faxes`,\n`/webhooks`, and `/events`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"mintfax","siteName":"mintfax","title":"Send a Fax - mintfax","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/fax/send-a-fax.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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.\">\u003cmeta data-mint-head name=\"application-name\" content=\"mintfax\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/mintfax/Wa2Q_xBkYrNNeJhI/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/mintfax/Wa2Q_xBkYrNNeJhI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/mintfax/Wa2Q_xBkYrNNeJhI/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/mintfax/Wa2Q_xBkYrNNeJhI/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/mintfax/Wa2Q_xBkYrNNeJhI/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/mintfax/Wa2Q_xBkYrNNeJhI/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/mintfax/Wa2Q_xBkYrNNeJhI/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/mintfax/Wa2Q_xBkYrNNeJhI/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/mintfax/Wa2Q_xBkYrNNeJhI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Send a Fax - mintfax\">\u003cmeta data-mint-head property=\"og:description\" content=\"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.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"mintfax\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://mintfax.com/docs/api-reference/fax/send-a-fax\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mintfax.mintlify.site/docs/_mintlify/api/og/v2?division=Fax\u0026amp;title=Send+a+Fax\u0026amp;description=Submit+a+fax+for+delivery.+The+file+is+staged+and+the+fax+is+queued+for+processing.%0AA+credit+hold+is+placed+on+submission+and+captured+on+delivery+or+released+o\u0026amp;theme=42e0c0e4e8bc2238519d7f78\u0026amp;signature=a19169eb21afe3a6475a113a1f0171032a643ee286407a6855d7a7a780ecfa35\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Send a Fax - mintfax\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mintfax.mintlify.site/docs/_mintlify/api/og/v2?division=Fax\u0026amp;title=Send+a+Fax\u0026amp;description=Submit+a+fax+for+delivery.+The+file+is+staged+and+the+fax+is+queued+for+processing.%0AA+credit+hold+is+placed+on+submission+and+captured+on+delivery+or+released+o\u0026amp;theme=42e0c0e4e8bc2238519d7f78\u0026amp;signature=a19169eb21afe3a6475a113a1f0171032a643ee286407a6855d7a7a780ecfa35\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/mintfax/Wa2Q_xBkYrNNeJhI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"mintfax\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16a34a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://mintfax.com/docs/api-reference/fax/send-a-fax\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/fax/send-a-fax.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://mintfax.com/#organization\",\"name\":\"mintfax\",\"url\":\"https://mintfax.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mintfax/zOe7HYdESMHdd_OE/logo/light.svg?fit=max\u0026auto=format\u0026n=zOe7HYdESMHdd_OE\u0026q=85\u0026s=765735134c5677c7b3bd07cb4a59b7a2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://mintfax.com/docs#website\",\"name\":\"mintfax\",\"url\":\"https://mintfax.com/docs\",\"publisher\":{\"@id\":\"https://mintfax.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://mintfax.com/docs/api-reference/fax/send-a-fax#webpage\",\"url\":\"https://mintfax.com/docs/api-reference/fax/send-a-fax\",\"name\":\"Send a Fax\",\"description\":\"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.\",\"isPartOf\":{\"@id\":\"https://mintfax.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://mintfax.com/docs/api-reference/fax/send-a-fax#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://mintfax.com/docs/api-reference/fax/send-a-fax#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"mintfax\",\"item\":\"https://mintfax.com/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Send a Fax\",\"item\":\"https://mintfax.com/docs/api-reference/fax/send-a-fax\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://mintfax.com/docs/api-reference/fax/send-a-fax#apireference\",\"headline\":\"Send a Fax\",\"name\":\"Send a Fax\",\"description\":\"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.\",\"url\":\"https://mintfax.com/docs/api-reference/fax/send-a-fax\",\"mainEntityOfPage\":{\"@id\":\"https://mintfax.com/docs/api-reference/fax/send-a-fax#webpage\"},\"publisher\":{\"@id\":\"https://mintfax.com/#organization\"},\"isPartOf\":{\"@id\":\"https://mintfax.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"mintfax\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"mintfax","nav":{"global":null,"tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":""}]},{"tab":"Guides","icon":"compass","pages":[{"title":"Guides","href":"/fax-api"}]},{"tab":"Resources","icon":"folder-open","pages":[{"title":"Resources","href":"/faq"}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/webhooks"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"API Reference","pages":[{"title":"Overview","href":"/api-reference/overview"}]},{"group":"Account","pages":[{"title":"Start Registration","deprecated":null,"version":null,"openapi":"/openapi.json post /account/register","href":"/api-reference/account/start-registration"},{"title":"Verify Registration Code","deprecated":null,"version":null,"openapi":"/openapi.json post /account/register/verify","href":"/api-reference/account/verify-registration-code"},{"title":"Get Account","deprecated":null,"version":null,"openapi":"/openapi.json get /account","href":"/api-reference/account/get-account"},{"title":"Get Account Balances","deprecated":null,"version":null,"openapi":"/openapi.json get /account/balance","href":"/api-reference/account/get-account-balances"},{"title":"Get Account Transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /account/transactions","href":"/api-reference/account/get-account-transactions"},{"title":"List API Keys","deprecated":null,"version":null,"openapi":"/openapi.json get /account/keys","href":"/api-reference/account/list-api-keys"},{"title":"Create API Key","deprecated":null,"version":null,"openapi":"/openapi.json post /account/keys","href":"/api-reference/account/create-api-key"},{"title":"Delete API Key","deprecated":null,"version":null,"openapi":"/openapi.json delete /account/keys/{id}","href":"/api-reference/account/delete-api-key"}]},{"group":"Environment","pages":[{"title":"Get Environment","deprecated":null,"version":null,"openapi":"/openapi.json get /environment","href":"/api-reference/environment/get-environment"},{"title":"Get Environment Balance","deprecated":null,"version":null,"openapi":"/openapi.json get /environment/balance","href":"/api-reference/environment/get-environment-balance"},{"title":"Get Environment Transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /environment/transactions","href":"/api-reference/environment/get-environment-transactions"},{"title":"Get Default Fax Settings","deprecated":null,"version":null,"openapi":"/openapi.json get /environment/fax-settings","href":"/api-reference/environment/get-default-fax-settings"},{"title":"Update Default Fax Settings","description":"Set default fax submission parameters for the environment. These apply to all\nfaxes unless overridden per submission.\nRequires an environment key (`mfx_test_...` or `mfx_live_...`).","deprecated":null,"version":null,"openapi":"/openapi.json put /environment/fax-settings","href":"/api-reference/environment/update-default-fax-settings"}]},{"group":"Fax","pages":[{"title":"Send a Fax","deprecated":null,"version":null,"openapi":"/openapi.json post /faxes","href":"/api-reference/fax/send-a-fax"},{"title":"List Faxes","description":"Returns a cursor-paginated list of faxes, most recent first.\nDefaults to the last 7 days; pass explicit `created_after` and\n`created_before` to widen or narrow the window.","deprecated":null,"version":null,"openapi":"/openapi.json get /faxes","href":"/api-reference/fax/list-faxes"},{"title":"Get a Fax","deprecated":null,"version":null,"openapi":"/openapi.json get /faxes/{fax}","href":"/api-reference/fax/get-a-fax"},{"title":"Get Fax Image","deprecated":null,"version":null,"openapi":"/openapi.json get /faxes/{fax}/image","href":"/api-reference/fax/get-fax-image"},{"title":"Resend a Fax","deprecated":null,"version":null,"openapi":"/openapi.json post /faxes/{fax}/resend","href":"/api-reference/fax/resend-a-fax"},{"title":"Purge a Fax","deprecated":null,"version":null,"openapi":"/openapi.json delete /faxes/{fax}","href":"/api-reference/fax/purge-a-fax"}]},{"group":"Events","pages":[{"title":"List Events","deprecated":null,"version":null,"openapi":"/openapi.json get /events","href":"/api-reference/events/list-events"},{"title":"Retrieve an Event","deprecated":null,"version":null,"openapi":"/openapi.json get /events/{event}","href":"/api-reference/events/retrieve-an-event"}]},{"group":"Webhooks","pages":[{"title":"List Webhook Endpoints","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks","href":"/api-reference/webhooks/create-webhook-endpoint"},{"title":"Update Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi.json put /webhooks/{webhook}","href":"/api-reference/webhooks/update-webhook-endpoint"},{"title":"Delete Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /webhooks/{webhook}","href":"/api-reference/webhooks/delete-webhook-endpoint"},{"title":"Rotate Signing Secret","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks/{webhook}/rotate-secret","href":"/api-reference/webhooks/rotate-signing-secret"},{"title":"List Webhook Delivery Attempts","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/attempts","href":"/api-reference/webhooks/list-webhook-delivery-attempts"},{"title":"Retrieve a Webhook Attempt","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/attempts/{attempt}","href":"/api-reference/webhooks/retrieve-a-webhook-attempt"},{"title":"Retry a Webhook Delivery","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks/attempts/{attempt}/retry","href":"/api-reference/webhooks/retry-a-webhook-delivery"}]}]}]},"basePath":"","title":"Send a Fax - mintfax","buildId":"dpl_ATnXPMW25DMPUr9VBw6kL6MfBt6T","deploymentId":"dpl_ATnXPMW25DMPUr9VBw6kL6MfBt6T","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CNqlzjVB.js","utils-BqFiXZ79.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CnR4QBe6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BY2ZM1OO.js","snippetPresets-x-8ACO8V.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ch-SJE05.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CqqG_0NE.js","shallow-BXrZ2b0C.js","getApiPlaygroundDisplay-n7J_wkjq.js","CodeSnippet-CQsp4vyQ.js","CodeSnippets-BfuHqvZx.js","Page-CTxrMSpo.js","getPastedJson-BjrGIK1i.js","icon-7iLZnVOC.js","MethodPill-TBS1m84e.js","DuplicateIcon-BNMrV4Vs.js","createIcon-C5kCqeU2.js","DynamicMarkdown-Bq09mRwR.js","SectionHeading-G4Bflf5Q.js","axios-vUo_bRtp.js","Markdown-BTUds0aX.js","clsx-6wHzaN2_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BPypQKlo.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-o6bee4ro.js"]}