# Retarus API > Explore the powerful APIs of the Retarus Enterprise Cloud, designed to streamline communication workflows, enhance integration, and enable seamless connectivity for your business applications. ## Table of contents - [index.md](https://developers.retarus.com/common.md) - [index.md](https://developers.retarus.com/idp.md) - [Authentication](https://developers.retarus.com/fax/authentication-fax.md) - [Retarus Faxolution for Applications Webservice](https://developers.retarus.com/fax.md) - [Example calls](https://developers.retarus.com/idp/example-calls.md) - [mock-servers.md](https://developers.retarus.com/common/mock-servers.md) - [Fax Inbound UDR Report](https://developers.retarus.com/common/graphql-fax-in-udr-example.md) - [Connecting AI tools to Retarus API Docs](https://developers.retarus.com/common/connecting-ai-tools.md) - [SMS Outbound UDR Report](https://developers.retarus.com/common/graphql-sms-out-example.md) - [Master data for IDP Capturing](https://developers.retarus.com/idp/masterdata-overview.md) - [Introduction to the Retarus GraphQL Reporting API](https://developers.retarus.com/common/graphql-introduction.md) - [IDP Masterdata Validator](https://developers.retarus.com/idp/masterdata-validator.md) - [GraphQL API Examples](https://developers.retarus.com/common/graphql-examples.md) - [Fax Outbound UDR Report](https://developers.retarus.com/common/graphql-fax-out-udr-example.md) - [SMS Inbound UDR Report](https://developers.retarus.com/common/graphql-sms-in-example.md) - [Transactional Email Event Report](https://developers.retarus.com/common/graphql-tem-events-example.md) - [Transactional Email UDR Report](https://developers.retarus.com/common/graphql-tem-udr-example.md) - [Retarus GraphQL Reporting API for Cloud Fax](https://developers.retarus.com/fax/reporting-api.md) - [Single Sign-On with OIDC](https://developers.retarus.com/idp/sso-with-oidc.md) - [Authentication and Endpoints](https://developers.retarus.com/common/graphql-authentication.md) - [index.md](https://developers.retarus.com/seg.md) - [Privacy Policy](https://developers.retarus.com/legal/privacy.md) - [index.md](https://developers.retarus.com/sms.md) - [index.md](https://developers.retarus.com/tem.md) - [Retarus GraphQL Reporting API for SMS](https://developers.retarus.com/sms/reporting-api.md) - [Swagger 2.X Description](https://developers.retarus.com/sms/swagger.md) - [Page currently under review](https://developers.retarus.com/tem/configuration-api.md) - [Retarus GraphQL Reporting API for Transactional Email](https://developers.retarus.com/tem/reporting-api.md) - [Swagger 2.X Description](https://developers.retarus.com/tem/swagger.md) - [Overview](https://developers.retarus.com/common/sdl.md) - [Public Status API](https://developers.retarus.com/common/status-api.md): The public status API allows to get an overall status for the Retarus Cloud Services. This includes current incidents, planned maintenances or important service information. Separated by service and region. For the public dashboard visit: [https://status.retarus.io](https://status.retarus.io) - [Fax Configuration API](https://developers.retarus.com/fax/fax-config-api.md): The fax configuration API allows you to administer: * Mail to Fax * Fax to Email * Fax to FTP * Fax to Webservice - [Fax2WSPull](https://developers.retarus.com/fax/fax2ws-pull-api.md): Fax2WSPull allows clients to actively retrieve faxes received for you via the Retarus cloud-based infrastructure instead of passively waiting for them to be delivered to a web service. The unit of organization for this process is the **topic**. A topic represents one or more fax numbers that are used to receive faxes. For each topic, the API provides information about received faxes, including the URL to the fax documents itself. Every inbound document showed as available is hidden after retrieval. However, fax receipt should be acknowledged by the client in the retrieval process. If this doesn't happen within a pre-defined timeout period, the document is made available again, assuming that there was some issue with the application during the retrieval process. Each request or response in this document is JSON serialized and encoded using the **UTF-8** character set. The fax documents themselves are automatically deleted **7 days** after receipt by default, regardless of whether they were downloaded or not. - [Faxolution for Applications (Fax4A) REST API](https://developers.retarus.com/fax/fax4a-api.md): 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 RESTful API using 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 * DE2 **United States** HA region US, including these data centers: * US1 * US2 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. - [Faxolution for Applications status push notification API](https://developers.retarus.com/fax/status-push-api.md): This document describes usage and possible content of the status push API. You can use it to be proactively informed about the outcome of the fax messages you sent with Faxolution for Applications. Both XML and JSON are available as file type. We recommend to use this option rather than polling the status via the Faxolution for Applications API or getting a notification via email. **Please note:** The following schema description as well as the examples refer to the default layout of the push message for XML and JSON. You can request an individual status push template from our implementation team. Also, some elements only show up in the push message, if they were referenced in the fax request. This is reflected in the examples. - [IDP Integration API](https://developers.retarus.com/idp/integration-gateway-openapi.md): API provided on the IDP Integration Gateway covers a few usage scenarios: ### Scenario 1: Masterdata & validation To upload masterdata files, or validate their content, use corresponding method from the *idp-masterdata* group. **Note**: Masterdata upload is a 2 step process. Successful response from any upload API call should be interpreted as a valid request to a masterdata upload. Actual lookup storage import is done asynchronously. ### Scenario 2: Process document – get result using polling method Prerequisite for this process is to have a published preset with which we want to process the document. 1. To start document processing use one of methods from the *idp-import* group, depending on the input document type (pdf, png, tiff, jpeg) In a response to any of these methods, if document upload is successful, system will respond with process UUID assigned to uploaded document. Subsequently, obtained UUID can be used as an input parameter in the next step. 2. Get-status from the *idp-process* group Provides document processing status. Get-status method returns a JSON payload with the status and last activity timestamp. Possible statuses are available in the method description. Both EXPORTED and REJECTED status are final statues and once process reaches one of those two states, no more processing is performed. If a process ended up in the EXPORTED state, processing result is available and one can proceed with the next step. 3. Get-xml-result from the *idp-process* group can be used to download XML file with the results of processing. To fetch the resulting XML, the client needs to provide IDP process UUID. In this scenario it is expected of client to store process UUID within its own datastore and use it to periodically check processing status. (polling get-status method) ### Scenario 3: Process document – get result using push method This scenario omits Get-status method and relies on the status push functionality to notify client system that processing has completed. Push functionality is configured on a pipeline level and can be combined with the pull method as well. This scenario begins with one of upload methods and, after the processing is completed, IDP will send status push notification. At this point the client can use Get-xml-result method to download resulting XML. ### Scenario 4: Process document – use IDP as a solution state store Scenario 2, and to some extent Scenario 3, require management of the overall document processing state (was it processed by IDP and subsequently the result was downloaded). In the Scenario 4, IDP keeps information about downstream processing status (result processed status) communicated to the system through the *acknowledge-result-processed* endpoint. Standard workflow in this scenario has the following steps: 1. Start document processing within IDP using one of the existing upload methods, but ignore assigned process UUID. (fire and forget upload) 2. Upload client is expected to periodically poll get-process-list from the *process-administration-controller* group to fetch a list of documents in an EXPORTED / REJECTED status with result processing not been acknowledged yet. 3. Process results obtained in 2. are then downloaded using get-xml-result endpoint if the processing status is EXPORTED. If the status is REJECTED there is no artifact for download. 4. Acknowledge result processing. ***Note 1***: Irrespective of the process result, if a process reaches one of the final states, *get-document-pdf* endpoint from the *idp-process* group can be used for obtaining input document pdf. ***Note 2***: Endpoint *acknowledge-result-processed* from the group *idp-process* must be called upon finishing steps for any of the scenarios 2-4. This call signalizes to the IDP system formal closure of the process and is used in IDP internally to appropriately handle such processes. - [Continuity-Service](https://developers.retarus.com/seg/email-continuity-api.md): REST service to maintain Retarus Email Continuity mailboxes and control failover routing - [SMS for Applications REST API](https://developers.retarus.com/sms/sms4a-api.md): The Retarus SMS for Applications REST API is a service to send SMS and lookup the status. To obtain a test account for this service or any of our other SMS services, please contact Retarus. - [seg-config-api](https://developers.retarus.com/seg/seg-config-openapi.md): API Gateway that provides a single point of entry for clients to manage customer configuration. - [Transactional Email API](https://developers.retarus.com/tem/m4a-api.md)