{"openapi":"3.1.0","info":{"title":"eFax API","description":"Use the eFax API to send faxes, view sent and received faxes, check fax status, and download fax documents. Faxes can include documents, a cover page, or both.\n\nAll endpoints use the `/v1` version prefix. A `fax_id` uniquely identifies a fax. It is returned when a fax is submitted and when faxes are listed, and can be used to check status or download the fax document.\n\nErrors use `application/problem+json` and include an `EFAX-*` error code. Every response includes an `X-Correlation-Id`; include this value when contacting eFax support.\n\n**Example data:** Names, organizations, fax numbers, identifiers, and message content shown in examples are fictional and are provided for illustration only. Field names, allowed values, error codes, and cover page template data describe the API contract.","contact":{"name":"eFax API Support"},"version":"1.31.0","summary":"Send, track, and receive faxes with eFax."},"servers":[{"url":"/","description":"Current environment."}],"security":[{"eFaxCredential":[]}],"tags":[{"name":"Cover Pages","description":"View available eFax cover page templates and their required fields."},{"name":"Faxes","description":"Send faxes, list fax history, check status, and download documents."}],"paths":{"/v1/faxes":{"get":{"tags":["Faxes"],"summary":"List and filter faxes","description":"List sent and received faxes. Omit all filters to return every available fax. Use `folder` to select `INBOX`, `OUTBOX`, or `TRASH`; `direction` to select `inbound` or `outbound` faxes; `fax_number` to match a sender or recipient fax number; and `from_date` / `to_date` to select an inclusive creation-time range. Folder and direction filters are case-insensitive.\n\nResults use zero-based page and size pagination and include `data`, `page`, `size`, `total_pages`, and `total_count`. Fax responses use status values `received`, `sending`, `delivered`, and `failed`; direction values `inbound` and `outbound`; and folder values `INBOX`, `OUTBOX`, and `TRASH`. An inverted date range returns `422 Unprocessable Entity`.","operationId":"listFaxes","parameters":[{"name":"folder","in":"query","description":"Folder/view to return. Matching is case-insensitive. Omit to include all folders.","schema":{"type":"string","enum":["inbox","outbox","trash"]},"example":"inbox"},{"name":"direction","in":"query","description":"Transmission direction. Matching is case-insensitive. Omit to include both directions.","schema":{"type":"string","enum":["inbound","outbound"]},"example":"outbound"},{"name":"fax_number","in":"query","description":"Originating or destination fax number to match, in E.164 format.","schema":{"type":"string"},"example":"+12025550164"},{"name":"from_date","in":"query","description":"Inclusive lower bound of the creation-time window, as an RFC 3339 offset date-time.","schema":{"type":"string","format":"date-time"},"example":"2026-06-01T00:00:00Z"},{"name":"to_date","in":"query","description":"Inclusive upper bound of the creation-time window, as an RFC 3339 offset date-time.","schema":{"type":"string","format":"date-time"},"example":"2026-06-30T23:59:59Z"},{"name":"page","in":"query","description":"Zero-based page index. Defaults to 0 when omitted.","schema":{"type":"integer","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"Maximum items per page. Defaults to 20; allowed range is 1 through 100.","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"example":20}],"responses":{"200":{"description":"A page of faxes matching the supplied filters.","headers":{"X-Correlation-Id":{"description":"Unique identifier for this request. Include it when contacting eFax support.","style":"simple","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxPage"},"examples":{"inboxPage":{"summary":"Example only — received faxes","description":"inboxPage","value":{"data":[{"fax_id":"11111111-1111-4111-8111-111111111111","direction":"inbound","status":"received","folder":"INBOX","originating_fax_number":"+12025550111","recipients":[{"name":"Records Department","fax_number":"+12025550123"}],"sender":"Example Health Clinic","subject":"Example records","page_count":3,"has_cover_page":false,"transmission_data":{"transmission_status":"COMPLETE","error_code":"","error_message":""},"created_at":"2026-06-24T15:41:09Z","received_at":"2026-06-24T15:41:09Z","completed_at":"2026-06-24T15:41:55Z","read":false,"favorite":false}],"page":0,"size":20,"total_pages":1,"total_count":1}},"outboxPage":{"summary":"Example only — sent faxes","description":"outboxPage","value":{"data":[{"fax_id":"22222222-2222-4222-8222-222222222222","direction":"outbound","status":"delivered","folder":"OUTBOX","originating_fax_number":"+12025550123","recipients":[{"name":"Example Insurance Company","fax_number":"+12025550164"}],"subject":"Example records","page_count":2,"has_cover_page":true,"transmission_data":{"transmission_status":"COMPLETE","error_code":"","error_message":""},"created_at":"2026-06-24T17:05:32Z","completed_at":"2026-06-24T17:08:10Z","read":false,"favorite":true}],"page":0,"size":20,"total_pages":3,"total_count":41}}}}},"links":{"faxDetail":{"operationId":"getFax","parameters":{"faxId":"$response.body#/data/0/fax_id"},"description":"Get the full detail and current status of the first fax on this page. Substitute the `data` index to follow any other fax on the page."},"faxDocument":{"operationId":"getFaxContent","parameters":{"faxId":"$response.body#/data/0/fax_id"},"description":"Download the document for the first fax on this page. Substitute the `data` index to download any other fax on the page."}}},"400":{"description":"A query parameter is malformed, out of range, or has an unsupported value.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"examples":{"invalidParameter":{"summary":"Example only — invalid query parameter","description":"invalidParameter","value":{"type":"https://problems.ccsi.la/efax-api/validation-error","title":"Validation Failed","status":400,"detail":"Request validation failed","instance":"/v1/faxes","code":"EFAX-400-VALIDATION","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z","errors":[{"field":"size","message":"must be less than or equal to 100"}]}}}}}},"422":{"description":"`from_date` is after `to_date`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"examples":{"invalidDateRange":{"summary":"Example only — inverted date range","description":"invalidDateRange","value":{"type":"https://problems.ccsi.la/efax-api/unprocessable-entity","title":"Unprocessable Entity","status":422,"detail":"from_date must not be after to_date.","instance":"/v1/faxes","code":"EFAX-422-UNPROCESSABLE","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z","errors":[{"field":"from_date","message":"from_date must not be after to_date."}]}}}}}},"401":{"description":"The eFax credential is missing, invalid, or revoked.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/unauthorized","title":"Unauthorized","status":401,"detail":"The eFax API credential is missing, invalid, or has been revoked.","instance":"/v1/faxes","code":"EFAX-401-UNAUTHENTICATED","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"403":{"description":"The credential is not permitted to access the requested account data.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/forbidden","title":"Forbidden","status":403,"detail":"The request was rejected by an upstream service.","instance":"/v1/faxes","code":"EFAX-403-FORBIDDEN","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"429":{"description":"The account-level request rate was exceeded.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/too-many-requests","title":"Too Many Requests","status":429,"detail":"Account rate limit exceeded.","instance":"/v1/faxes","code":"EFAX-429-RATE-LIMITED","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"500":{"description":"An unexpected error occurred.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred","instance":"/v1/faxes","code":"EFAX-500-INTERNAL","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"503":{"description":"The eFax service is temporarily unavailable. Please retry later.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/service-unavailable","title":"Service Unavailable","status":503,"detail":"A required downstream service is temporarily unavailable. Please retry later.","instance":"/v1/faxes","code":"EFAX-503-DOWNSTREAM-UNAVAILABLE","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}}}},"post":{"tags":["Faxes"],"summary":"Send a fax","description":"Send a fax to one or more recipients using `multipart/form-data`. Include a required JSON `metadata` part and, when needed, one or more `files` parts. Each fax must include at least one document, a valid cover page, or both. A request can contain up to 20 files with a combined size of 100 MB. Use `GET /v1/cover-pages` to find available cover page names and their required fields.\n\nOne fax is attempted for each recipient. The `202 Accepted` response contains a result for every recipient in request order. The overall `outcome` is `succeeded`, `partial`, or `failed`; check each item in `fax_ids` for its `status`, `fax_id`, or error details.\n\n### Example 1: Send documents without a cover page\nAdd one or more document parts named `files` and use this JSON for the `metadata` part:\n\n```json\n{\n  \"metadata\": {\n    \"recipients\": [{\n      \"name\": \"Example Insurance Company\",\n      \"company\": \"Example Insurance Company\",\n      \"fax_number\": \"+12025550164\"\n    }]\n  }\n}\n```\n\n### Example 2: Send a cover page with documents\nAdd one or more document parts named `files` and use this JSON for the `metadata` part:\n\n```json\n{\n  \"metadata\": {\n    \"originating_fax_number\": \"+12025550123\",\n    \"recipients\": [{\n      \"name\": \"Dr. Jane Example\",\n      \"company\": \"Example Health Clinic\",\n      \"fax_number\": \"+12025550164\"\n    }]\n  },\n  \"cover_page\": {\n    \"name\": \"Default\",\n    \"fields\": {\n      \"to-name\": \"Dr. Jane Example\",\n      \"from-name\": \"Records Department\",\n      \"fax-back-number\": \"+12025550123\",\n      \"from-company\": \"Example Healthcare Organization\",\n      \"subject\": \"Example records\",\n      \"message\": \"Please confirm receipt.\"\n    }\n  }\n}\n```\n\n### Example 3: Send a cover-page-only fax\nDo not add a `files` part. Use this JSON for the `metadata` part:\n\n```json\n{\n  \"metadata\": {\n    \"recipients\": [{\n      \"name\": \"Dr. Jane Example\",\n      \"fax_number\": \"+12025550164\"\n    }]\n  },\n  \"cover_page\": {\n    \"name\": \"Default\",\n    \"fields\": {\n      \"to-name\": \"Dr. Jane Example\",\n      \"from-name\": \"Records Department\",\n      \"fax-back-number\": \"+12025550123\",\n      \"message\": \"Cover-page-only notification.\"\n    }\n  }\n}\n```\n\n### Example 4: Send documents to multiple recipients\nAdd one or more document parts named `files`. Every recipient receives the same document set, and the response contains a separate result for each recipient. Use this JSON for the `metadata` part:\n\n```json\n{\n  \"metadata\": {\n    \"recipients\": [\n      {\n        \"name\": \"Example Insurance Company\",\n        \"company\": \"Example Insurance Company\",\n        \"fax_number\": \"+12025550164\"\n      },\n      {\n        \"name\": \"Dr. Jane Example\",\n        \"company\": \"Example Health Clinic\",\n        \"fax_number\": \"+12025550165\"\n      }\n    ]\n  }\n}\n```","operationId":"sendFax","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/CreateMessageRequest"},"files":{"type":"array","description":"Optional document parts to transmit. Include zero parts for a valid cover-page-only fax, one part for a single document, or several parts for a multi-document fax. At most 20 files and 100 MB total.","items":{"type":"string","format":"binary"},"maxItems":20}},"required":["metadata"]},"encoding":{"metadata":{"contentType":"application/json"}}}}},"responses":{"202":{"description":"The fax request was accepted. The response includes a result for each recipient.","headers":{"X-Correlation-Id":{"description":"Unique identifier for this request. Include it when contacting eFax support.","style":"simple","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendFaxResponse"},"examples":{"succeeded":{"summary":"Example only — every recipient queued","description":"succeeded","value":{"outcome":"succeeded","fax_ids":[{"status":"queued","fax_id":"22222222-2222-4222-8222-222222222222","fax_number":"+12025550164"},{"status":"queued","fax_id":"44444444-4444-4444-8444-444444444444","fax_number":"+12025550165"}],"created_at":"2026-06-24T17:05:32Z"}},"partial":{"summary":"Example only — some recipients queued and some failed","description":"partial","value":{"outcome":"partial","fax_ids":[{"status":"queued","fax_id":"22222222-2222-4222-8222-222222222222","fax_number":"+12025550164"},{"status":"error","fax_number":"+1202","error_code":"INVALID_FAX_NUMBER","error_message":"The recipient fax number is invalid."}],"created_at":"2026-06-24T17:05:32Z"}},"failed":{"summary":"Example only — every recipient failed; still 202","description":"failed","value":{"outcome":"failed","fax_ids":[{"status":"error","fax_number":"+1202","error_code":"INVALID_FAX_NUMBER","error_message":"The recipient fax number is invalid."}],"created_at":"2026-06-24T17:05:32Z"}}}}},"links":{"faxStatus":{"operationId":"getFax","parameters":{"faxId":"$response.body#/fax_ids/0/fax_id"},"description":"Check the delivery status of the first queued recipient. Repeat for each `fax_ids` entry whose `status` is `queued`; an entry with `status` `error` carries no `fax_id`."},"faxDocument":{"operationId":"getFaxContent","parameters":{"faxId":"$response.body#/fax_ids/0/fax_id"},"description":"Download the transmitted document for the first queued recipient, once that fax reaches `delivered`."}}},"400":{"description":"The multipart request or JSON `metadata` part is malformed.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/request-body-not-readable","title":"Malformed Request Body","status":400,"detail":"Request body is malformed or unreadable","instance":"/v1/faxes","code":"EFAX-400-VALIDATION","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"401":{"description":"The eFax credential is missing, invalid, or revoked.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/unauthorized","title":"Unauthorized","status":401,"detail":"The eFax API credential is missing, invalid, or has been revoked.","instance":"/v1/faxes","code":"EFAX-401-UNAUTHENTICATED","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"403":{"description":"The account is not configured to send faxes.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/forbidden","title":"Forbidden","status":403,"detail":"No active outbound fax subscription found","instance":"/v1/faxes","code":"EFAX-403-FORBIDDEN","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"413":{"description":"The total upload exceeds 100 MB.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/payload-too-large","title":"Payload Too Large","status":413,"detail":"Total upload size must not exceed 100 MB.","instance":"/v1/faxes","code":"EFAX-413-TOO-LARGE","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z","errors":[{"field":"files","message":"Total upload size must not exceed 100 MB."}]}}}},"415":{"description":"The request uses a content type other than `multipart/form-data`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/media-type-not-supported","title":"Unsupported Media Type","status":415,"detail":"Content-Type 'application/json' is not supported","instance":"/v1/faxes","code":"EFAX-415-UNSUPPORTED-MEDIA","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"422":{"description":"The request is well formed but cannot be processed, such as when there are no recipients, too many files, or an invalid cover page.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/unprocessable-entity","title":"Unprocessable Entity","status":422,"detail":"At least one document or a valid cover page is required.","instance":"/v1/faxes","code":"EFAX-422-UNPROCESSABLE","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z","errors":[{"field":"files","message":"At least one document or a valid cover page is required."}]}}}},"429":{"description":"The account-level request rate was exceeded.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/too-many-requests","title":"Too Many Requests","status":429,"detail":"Account rate limit exceeded.","instance":"/v1/faxes","code":"EFAX-429-RATE-LIMITED","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"500":{"description":"An unexpected error occurred.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred","instance":"/v1/faxes","code":"EFAX-500-INTERNAL","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"503":{"description":"Authentication is temporarily unavailable. Please retry later.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"examples":{"authenticationUnavailable":{"summary":"Example only — authentication temporarily unavailable","description":"authenticationUnavailable","value":{"type":"https://problems.ccsi.la/efax-api/service-unavailable","title":"Service Unavailable","status":503,"detail":"The authentication service is temporarily unavailable.","instance":"/v1/faxes","code":"EFAX-503-DOWNSTREAM-UNAVAILABLE","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}}}}}}},"/v1/faxes/{faxId}":{"get":{"tags":["Faxes"],"summary":"Get fax status","description":"Get the current status and details for a sent or received fax using its `fax_id`. The response includes direction, status, folder, sender and recipient information, page count, transmission details, and timestamps. Status is `received`, `sending`, `delivered`, or `failed`; direction is `inbound` or `outbound`; and folder is `INBOX`, `OUTBOX`, or `TRASH`. Download the fax document separately with `GET /v1/faxes/{faxId}/content`.","operationId":"getFax","parameters":[{"name":"faxId","in":"path","description":"Fax identifier returned when a fax is sent or listed.","required":true,"schema":{"type":"string","format":"uuid"},"example":"11111111-1111-4111-8111-111111111111"}],"responses":{"200":{"description":"The requested fax and its current status.","headers":{"X-Correlation-Id":{"description":"Unique identifier for this request. Include it when contacting eFax support.","style":"simple","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fax"},"examples":{"inboundFax":{"summary":"Example only — received fax","description":"inboundFax","value":{"fax_id":"11111111-1111-4111-8111-111111111111","direction":"inbound","status":"received","folder":"INBOX","originating_fax_number":"+12025550111","recipients":[{"fax_number":"+12025550123"}],"created_at":"2026-06-24T15:41:09Z","read":false,"favorite":false}},"outboundFailedFax":{"summary":"Example only — sent fax that failed","description":"outboundFailedFax","value":{"fax_id":"22222222-2222-4222-8222-222222222222","direction":"outbound","status":"failed","folder":"OUTBOX","originating_fax_number":"+12025550123","recipients":[{"fax_number":"+12025550164"}],"created_at":"2026-06-24T17:05:32Z","read":false,"favorite":false}}}}},"links":{"faxDocument":{"operationId":"getFaxContent","parameters":{"faxId":"$request.path.faxId"},"description":"Download this fax's document. A received fax returns PDF; a sent fax returns TIFF."}}},"400":{"description":"`faxId` is not a valid UUID.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/validation-error","title":"Validation Failed","status":400,"detail":"Request validation failed","instance":"/v1/faxes/not-a-uuid","code":"EFAX-400-VALIDATION","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z","errors":[{"field":"faxId","message":"must be a valid UUID format"}]}}}},"401":{"description":"The eFax credential is missing, invalid, or revoked.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/unauthorized","title":"Unauthorized","status":401,"detail":"The eFax API credential is missing, invalid, or has been revoked.","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333","code":"EFAX-401-UNAUTHENTICATED","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"403":{"description":"The credential is not permitted to access this fax.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/forbidden","title":"Forbidden","status":403,"detail":"The request was rejected by an upstream service.","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333","code":"EFAX-403-FORBIDDEN","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"404":{"description":"No fax exists with this `faxId`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"examples":{"faxNotFound":{"summary":"Example only — fax not found","description":"faxNotFound","value":{"type":"https://problems.ccsi.la/efax-api/resource-not-found","title":"Resource Not Found","status":404,"detail":"No fax exists with id 33333333-3333-4333-8333-333333333333.","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333","code":"EFAX-404-NOT-FOUND","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}}}},"429":{"description":"The account-level request rate was exceeded.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/too-many-requests","title":"Too Many Requests","status":429,"detail":"Account rate limit exceeded.","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333","code":"EFAX-429-RATE-LIMITED","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"500":{"description":"An unexpected error occurred.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333","code":"EFAX-500-INTERNAL","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"503":{"description":"A required service is temporarily unavailable. Please retry later.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/service-unavailable","title":"Service Unavailable","status":503,"detail":"A required downstream service is temporarily unavailable. Please retry later.","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333","code":"EFAX-503-DOWNSTREAM-UNAVAILABLE","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}}}}},"/v1/faxes/{faxId}/content":{"get":{"tags":["Faxes"],"summary":"Download a fax document","description":"Download the document for a sent or received fax. Received fax documents are returned as PDF and sent fax documents are returned as TIFF. If the fax or its downloadable document does not exist, the operation returns 404.","operationId":"getFaxContent","parameters":[{"name":"faxId","in":"path","description":"Fax identifier returned when a fax is sent or listed.","required":true,"schema":{"type":"string","format":"uuid"},"example":"11111111-1111-4111-8111-111111111111"}],"responses":{"200":{"description":"The fax document bytes in their stored format: PDF for received faxes or TIFF for sent faxes.","headers":{"X-Correlation-Id":{"description":"Unique identifier for this request. Include it when contacting eFax support.","style":"simple","schema":{"type":"string","format":"uuid"}}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"`faxId` is not a valid UUID.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/validation-error","title":"Validation Failed","status":400,"detail":"Request validation failed","instance":"/v1/faxes/not-a-uuid/content","code":"EFAX-400-VALIDATION","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z","errors":[{"field":"faxId","message":"must be a valid UUID format"}]}}}},"401":{"description":"The eFax credential is missing, invalid, or revoked.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/unauthorized","title":"Unauthorized","status":401,"detail":"The eFax API credential is missing, invalid, or has been revoked.","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333/content","code":"EFAX-401-UNAUTHENTICATED","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"403":{"description":"The credential is not permitted to access this fax.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/forbidden","title":"Forbidden","status":403,"detail":"The request was rejected by an upstream service.","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333/content","code":"EFAX-403-FORBIDDEN","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"404":{"description":"The fax or its downloadable document does not exist.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"examples":{"documentNotFound":{"summary":"Example only — document not found","description":"documentNotFound","value":{"type":"https://problems.ccsi.la/efax-api/resource-not-found","title":"Resource Not Found","status":404,"detail":"No downloadable content found for fax_id: 33333333-3333-4333-8333-333333333333","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333/content","code":"EFAX-404-NOT-FOUND","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}}}},"429":{"description":"The account-level request rate was exceeded.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/too-many-requests","title":"Too Many Requests","status":429,"detail":"Account rate limit exceeded.","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333/content","code":"EFAX-429-RATE-LIMITED","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"500":{"description":"An unexpected error occurred.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333/content","code":"EFAX-500-INTERNAL","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"503":{"description":"A required service is temporarily unavailable. Please retry later.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/service-unavailable","title":"Service Unavailable","status":503,"detail":"A required downstream service is temporarily unavailable. Please retry later.","instance":"/v1/faxes/33333333-3333-4333-8333-333333333333/content","code":"EFAX-503-DOWNSTREAM-UNAVAILABLE","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}}}}},"/v1/cover-pages":{"get":{"tags":["Cover Pages"],"summary":"List cover page templates","description":"List the cover page templates available when sending a fax. Each template includes the exact `name` to use in `metadata.cover_page.name`, along with the required and optional fields accepted in `metadata.cover_page.fields`.\n\nAvailable templates and field requirements may change. Retrieve this list before sending a fax instead of hard-coding template details.","operationId":"getCoverPages","responses":{"200":{"description":"All available eFax cover page templates.","headers":{"X-Correlation-Id":{"description":"Unique identifier for this request. Include it when contacting eFax support.","style":"simple","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoverPagesResponse"},"examples":{"catalog":{"summary":"Example only — available eFax cover pages","description":"catalog","value":{"cover_pages":[{"name":"Announcement","description":"Announcement-style fax cover sheet","required_fields":["to-name","from-name","fax-back-number"],"optional_fields":["from-company","message"]},{"name":"Urgent","description":"Urgent-style fax cover sheet","required_fields":["to-name","from-name","fax-back-number"],"optional_fields":["from-company","subject","message"]},{"name":"Default","description":"Standard clean fax cover sheet","required_fields":["to-name","from-name","fax-back-number"],"optional_fields":["from-company","message","subject"]}]}}}}},"links":{"sendWithCoverPage":{"operationId":"sendFax","description":"Send a fax using one of these templates. Copy a template's `name` into `metadata.cover_page.name`, and supply every entry in its `required_fields` under `metadata.cover_page.fields`."}}},"401":{"description":"The eFax credential is missing, invalid, or revoked.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/unauthorized","title":"Unauthorized","status":401,"detail":"The eFax API credential is missing, invalid, or has been revoked.","instance":"/v1/cover-pages","code":"EFAX-401-UNAUTHENTICATED","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"429":{"description":"The account-level request rate was exceeded.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/too-many-requests","title":"Too Many Requests","status":429,"detail":"Account rate limit exceeded.","instance":"/v1/cover-pages","code":"EFAX-429-RATE-LIMITED","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"500":{"description":"An unexpected error occurred.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"example":{"type":"https://problems.ccsi.la/efax-api/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred","instance":"/v1/cover-pages","code":"EFAX-500-INTERNAL","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}},"503":{"description":"Authentication is temporarily unavailable. Please retry later.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/EfaxProblem"},"examples":{"authenticationUnavailable":{"summary":"Example only — authentication temporarily unavailable","description":"authenticationUnavailable","value":{"type":"https://problems.ccsi.la/efax-api/service-unavailable","title":"Service Unavailable","status":503,"detail":"The authentication service is temporarily unavailable.","instance":"/v1/cover-pages","code":"EFAX-503-DOWNSTREAM-UNAVAILABLE","correlation_id":"00000000-0000-4000-8000-000000000001","timestamp":"2026-06-24T17:05:32Z"}}}}}}}}}},"components":{"schemas":{"EfaxProblem":{"type":"object","description":"RFC 9457 error details with stable eFax code, request correlation, timestamp, and optional field errors.","properties":{"type":{"type":"string","format":"uri","description":"URI identifying the problem type."},"title":{"type":"string","description":"Short problem title."},"status":{"type":"integer","format":"int32","description":"HTTP response status."},"detail":{"type":"string","description":"Customer-safe explanation of this occurrence."},"instance":{"type":"string","format":"uri","description":"Request path for this occurrence."},"code":{"type":"string","description":"Stable eFax error code."},"correlation_id":{"type":"string","format":"uuid","description":"Identifier used to trace this request."},"timestamp":{"type":"string","format":"date-time","description":"Time at which the error response was created."},"errors":{"type":"array","description":"Optional field-level validation errors.","items":{"type":"object","properties":{"field":{"type":"string","description":"Request field associated with the error."},"message":{"type":"string","description":"Customer-safe validation message."}}}}}},"CoverPageSelection":{"type":"null","properties":{"name":{"type":["string","null"]},"fields":{"type":["object","null"],"additionalProperties":{"type":"string"}}}},"CreateMessageRequest":{"type":"object","description":"Required JSON part containing recipients, an optional sending fax number, and an optional eFax cover page. See the four examples in the operation description and below.","properties":{"metadata":{"$ref":"#/components/schemas/MessageMetadata"},"cover_page":{"$ref":"#/components/schemas/CoverPageSelection"}}},"MessageMetadata":{"type":"null","properties":{"originating_fax_number":{"type":["string","null"]},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"},"maxItems":50}}},"Recipient":{"type":"object","properties":{"name":{"type":["string","null"]},"company":{"type":["string","null"]},"fax_number":{"type":["string","null"]}}},"FaxAck":{"type":"object","properties":{"status":{"type":"string","enum":["queued","error"]},"fax_id":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"error_code":{"type":["string","null"]},"error_message":{"type":["string","null"]}}},"SendFaxResponse":{"type":"object","properties":{"outcome":{"type":"string","enum":["succeeded","partial","failed"]},"fax_ids":{"type":"array","items":{"$ref":"#/components/schemas/FaxAck"}},"created_at":{"type":"string","format":"date-time"}}},"Fax":{"type":"object","properties":{"fax_id":{"type":["string","null"]},"direction":{"type":["string","null"]},"status":{"type":["string","null"]},"folder":{"type":["string","null"]},"originating_fax_number":{"type":["string","null"]},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"sender":{"type":["string","null"]},"subject":{"type":["string","null"]},"page_count":{"type":["integer","null"],"format":"int32"},"has_cover_page":{"type":"boolean"},"transmission_data":{"$ref":"#/components/schemas/TransmissionData"},"created_at":{"type":["string","null"],"format":"date-time"},"received_at":{"type":["string","null"],"format":"date-time"},"completed_at":{"type":["string","null"],"format":"date-time"},"read":{"type":"boolean"},"favorite":{"type":"boolean"}}},"FaxPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Fax"}},"page":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"total_pages":{"type":"integer","format":"int32"},"total_count":{"type":"integer","format":"int64"}}},"TransmissionData":{"type":"null","properties":{"transmission_status":{"type":["string","null"]},"error_code":{"type":"string"},"error_message":{"type":"string"}}},"CoverPageTemplate":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"required_fields":{"type":"array","items":{"type":"string"}},"optional_fields":{"type":"array","items":{"type":"string"}}}},"CoverPagesResponse":{"type":"object","properties":{"cover_pages":{"type":"array","items":{"$ref":"#/components/schemas/CoverPageTemplate"}}}}},"securitySchemes":{"eFaxCredential":{"type":"http","description":"Enter the eFax API credential provided for your account. Send the credential with each request as `Authorization: Bearer <credential>`. A missing or invalid credential returns `401 EFAX-401-UNAUTHENTICATED`.","scheme":"bearer","bearerFormat":"opaque"}}}}