Mainstay Fax API

## Sections
• [/tokens](https://app.theneo.io/aizan/mainstay-fax-api/cognito-oauth2-token.md): Mapped to AWS Cognito's /oauth2/token that allows users to request access tokens for authenticating and authorizing client applications.
• [/health](https://app.theneo.io/aizan/mainstay-fax-api/health.md): Allows to check the current health status of the service.
• [/faxes/received](https://app.theneo.io/aizan/mainstay-fax-api/faxes-received.md): The /faxes/received section allows users to retrieve a list of faxes that have been received by the user. Users can access details such as fax-id, size, duration, pages, and timestamps related to the received faxes, facilitating efficient management and tracking of incoming fax communications. This section helps users conveniently access and review their received faxes within the application.
• [/faxes/sent](https://app.theneo.io/aizan/mainstay-fax-api/faxes-sent.md): The /faxes/sent section allows users to retrieve information on faxes that have been successfully sent. Users can access details such as fax-id, size, duration, pages, and transmission status to track the status and details of their sent faxes. This section provides a comprehensive overview of all successfully sent faxes for user reference and tracking purposes.
• [/faxes/metadata](https://app.theneo.io/aizan/mainstay-fax-api/faxes-metadata.md): The /faxes/metadata section allows users to retrieve a list of metadata associated with specified fax-ids. By utilizing this API endpoint, users can access additional information such as fax size, duration, page count, and status for specific faxes, enabling them to manage and track fax transmissions efficiently.
• [/faxes](https://app.theneo.io/aizan/mainstay-fax-api/external-number-2-faxes-pdf.md): The /faxes section allows users to send fax transmissions with customizable options, such as resolution settings, cover page inclusion, and billing details. Users can specify recipient information, document types, and additional client data to facilitate the fax transmission process. The section returns a unique fax-id and destination fax number upon successful submission.
• [/faxes/{fax_id}/metadata](https://app.theneo.io/aizan/mainstay-fax-api/faxes-1-metadata.md): This section provides detailed information about a specific fax, including size, duration, pages, status, and more. Users can retrieve comprehensive metadata about a fax transmission, enabling them to track and manage fax communications effectively within their application.
• [/faxes/{fax_id}/metadata](https://app.theneo.io/aizan/mainstay-fax-api/patcg-faxes-fax_id-metadata-copy-1.md): This section allows users to update and retrieve detailed metadata for a specific fax transmission. This call allows the end user to edit limited information on a SINGLE fax image (either sent or received) from a metadata list obtained in a previous “listing” query. The only available metadata field for editing is "image_downloaded".
• [/faxes/{fax_id}/image](https://app.theneo.io/aizan/mainstay-fax-api/faxes-1-image.md): This section allows users to retrieve the image associated with a specific fax-id. By accessing this endpoint, users can view and download the image file, along with relevant metadata such as the file name. This functionality enables seamless integration of fax image retrieval into various applications and workflows.
• [/faxes/{fax_id}/image/pages](https://app.theneo.io/aizan/mainstay-fax-api/faxes-1-image-pages.md): This section allows users to retrieve specific pages of a fax image by providing the fax-id and specifying the starting page number and the number of pages to retrieve. Users can access individual pages of a fax image for viewing or processing purposes through this API section.
• [/faxes/{fax_id}](https://app.theneo.io/aizan/mainstay-fax-api/faxes-1.md): This request allows users to delete a specific fax by its fax-id.
• [/faxes/{fax_id}/cancel](https://app.theneo.io/aizan/mainstay-fax-api/faxes-1-cancel.md): This request allows users to cancel a specific fax by its fax-id.
• [/faxes/{fax_id}/transmission-details](https://app.theneo.io/aizan/mainstay-fax-api/faxes-1-transmission-details.md): This section provides detailed transmission information for a specific fax, including status, timestamps, error codes, and retry data. Users can retrieve comprehensive details about the transmission process to track the progress and troubleshoot any issues effectively.
• [/applications/{application-id}/notifications](https://app.theneo.io/aizan/mainstay-fax-api/applications-application-id-notifications.md): This section allows users to retrieve notifications associated with a specific application.
• [/applications/{application-id}/notifications](https://app.theneo.io/aizan/mainstay-fax-api/applications-application-id-notifications-1.md): This section allows users to send notifications within a specific application, specifying details such as notification direction, type, destination, and HMAC secret for message integrity verification.
• [/applications/{application-id}/notifications/{notification-id}](https://app.theneo.io/aizan/mainstay-fax-api/applications-application-id-notifications-notification-id.md): This section allows users to delete a specific notification associated with an application.
• [/applications/{application-id}/notifications/{notification-id}](https://app.theneo.io/aizan/mainstay-fax-api/applications-application-id-notifications-notification-id-1.md): This section allows users to update specific notifications associated with a particular application.
• [/notifications](https://app.theneo.io/aizan/mainstay-fax-api/notifications-1.md): The /notifications section provides users with the ability to retrieve detailed information about specific transactions, including timestamp, fax direction, and sent status. By utilizing various parameters, users can efficiently access transmission details for their transactions without the need for manual data extraction. This section streamlines the process of retrieving transaction information, enhancing efficiency and facilitating seamless integration with other systems.
• [/reports/usage](https://app.theneo.io/aizan/mainstay-fax-api/reports.md): The /reports/usage section provides authenticated administrators with a list of usage reports based on specified query parameters. Users can retrieve download URLs for various reports by setting parameters such as report period, service type, start date, and end date, enabling them to programmatically access and download the necessary reports as needed. Returns a list of usage reports according to the query parameters reportPeriod, serviceType, startDate and endDate, providing the download URL of each report, for the authenticated administrator. Using this endpoint response, the client can programmatically get and download the set of reports he needs by selecting the appropriate query parameters and then iterating through the response records downloading the ones he needs using the URLs as-is.
• [/reports/usage/download/{report-key}](https://app.theneo.io/aizan/mainstay-fax-api/reports-usage-download-report-key.md): This section enables users to download usage reports by providing a unique report key. Users can retrieve detailed usage data in various file formats to analyze and track their consumption patterns efficiently. This feature streamlines the process of accessing and managing critical usage information for better decision-making.