Faxolution for Applications (Fax4A) REST API (v1)

Retarus' Faxolution for Applications webservice facilitates automation of the fax transmission process. In addition, it also allows you to monitor the status of a sent fax and delete archived reports. The Webservice communicates via REST 1.0 (JSON). The programming language with which the Webservice client is implemented is not restricted by the Webservice itself.

Fax transmission is generally divided into the following steps:

  • Create a fax job and send it to the webservice

then either

  • Retrieve completed fax jobs

    GET /{custNr}/fax/reports

  • Retrieve the status details for the completed jobs individually or in bulk

    GET /{custNr}/fax/reports/{jobId} or POST /{custNr}/fax/reports

  • Delete the retrieved jobs individually or in bulk

    DELETE /{custNr}/fax/reports/{jobId} or POST /{custNr}/fax/reports

or

  • Receive the fax job status per HTTP push and/or email status Report

Fax job data will be automatically deleted after the configured retention time.

For highest process safety standards, we operate two high availability (HA) regions, where data centers are clustered. This is how the HA regions are composed:

Germany
HA region DE, including these data centers:

  • DE1: DC in Frankfurt
  • DE2: DC in Munich

United States
HA region US, including these data centers:

  • US1: DC Ashburn
  • US2: DC Secaucus

Please see the individual operations for details on how to work with HA settings.

To obtain a test account for this service or any of our other fax services, please contact Retarus.

Download OpenAPI description
Languages
Servers
Mock server
https://developers.retarus.com/_mock/fax/fax4a-api/
Retarus data center in Germany
https://faxws.de1.retarus.com/rest/v1/
Retarus data center in Germany
https://faxws.de2.retarus.com/rest/v1/
High availability URL for German data centers
https://faxws-ha.de.retarus.com/rest/v1/
Retarus data center in USA
https://faxws.us1.retarus.com/rest/v1/
Retarus data center in USA
https://faxws.us2.retarus.com/rest/v1/
High availability URL for US data centers
https://faxws-ha.us.retarus.com/rest/v1/
Retarus data center in Switzerland
https://faxws.ch1.retarus.com/rest/v1/
Retarus data center in Singapore
https://faxws.sg1.retarus.com/rest/v1/

Fax jobs

Send faxes

Operations

Fax reports

Operations