# SRFax
URL: https://docs.awellhealth.com/docs/marketplace/srfax

> For the complete documentation index, see [llms.txt](https://docs.awellhealth.com/llms.txt).



<img src="/marketplace/srfax.jpg" width="48" height="48" />

Retrieve faxes from SRFax and extract text using LandingAI OCR.

Category: Document Management. Adds 1 action to a care flow.

## What to configure [#what-to-configure]

Set these once, on the extension in Awell Studio. An action fails at run time if a
required setting is missing.

| Setting    | Required | Notes                 |
| ---------- | -------- | --------------------- |
| Account ID | Yes      | —                     |
| Base URL   | No       | —                     |
| Password   | Yes      | — Stored as a secret. |

## Actions [#actions]

SRFax adds this action to a care flow. Add one to a step, then fill in its inputs.

### Get fax document with OCR [#get-fax-document-with-ocr]

Get fax document with SRFax and extract structured data with OCR

This action can be previewed in Studio before you publish.

| Input                | Type     | Required | Description                                                                                                                                                                                 |
| -------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Fax Id               | `string` | Yes      | SRFax FaxDetailsID (the number after the "\|" in FileName) or full FileName                                                                                                                 |
| OCR Provider         | `string` | Yes      | The provider or service used for OCR One of: Awell (Landing.ai).                                                                                                                            |
| OCR Provider API Key | `string` | Yes      | We advise using a obfuscated constant                                                                                                                                                       |
| Fields schema        | `json`   | No       | Defines the structure of the fields to extract from the document. Providing a schema is optional but strongly recommended, as it significantly improves the accuracy of the extracted data. |

Returns:

| Data point                   | Type     |
| ---------------------------- | -------- |
| `chunks`                     | `json`   |
| `date`                       | `date`   |
| `direction`                  | `string` |
| `extractedDataBasedOnSchema` | `json`   |
| `extractedMetadata`          | `json`   |
| `format`                     | `string` |
| `markdown`                   | `string` |
| `pageCount`                  | `number` |
| `status`                     | `string` |

## Setup and notes [#setup-and-notes]

Retrieve fax documents from SRFax and extract text via LandingAI OCR.

### Extension settings [#extension-settings]

* Account ID (required)
* Password (required)
* Base URL (optional, default: [https://www.srfax.com/SRF\_SecWebSvc.php](https://www.srfax.com/SRF_SecWebSvc.php))

### Action: Get fax document with OCR [#action-get-fax-document-with-ocr]

* Inputs
  * faxId (string, required): SRFax FaxDetailsID (number after the `|`) or full FileName
  * ocrProvider: `awell-landing-ai`
  * ocrProviderApiKey (string, required)
  * fieldsSchema (JSON, optional)
* Outputs
  * markdown (string)
  * chunks (json)
  * extractedDataBasedOnSchema (json)
  * extractedMetadata (json)
  * direction (string)
  * date (date)
  * status (string)
  * format (string)
  * pageCount (number)

## Changelog [#changelog]

All notable changes to the SRFax extension will be documented in this file.

### 1.0.0 [#100]

* Initial release: getFaxDocumentWithOCR action using SRFax Retrieve\_Fax and LandingAI OCR (base64 mode).

## Where this page comes from [#where-this-page-comes-from]

The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at `@awell-health/awell-extensions` v2.1.159. They match what the
platform actually does rather than a description of it.

Field-level detail also appears in Awell Studio when you configure the action.
Something wrong or missing? Email [support@awellhealth.com](mailto:support@awellhealth.com).