Send Fax

Send Fax

curl --request POST \
  --url https://api.decodahealth.com/faxes \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "faxContactId": "<string>",
  "mergedGcsPath": "<string>",
  "attachments": [
    {
      "gcsPath": "<string>",
      "filename": "<string>",
      "displayOrder": 0,
      "documentId": "<string>"
    }
  ],
  "phoneNumberId": "<string>",
  "patientId": "<string>"
}
'

import requests

url = "https://api.decodahealth.com/faxes"

payload = {
    "faxContactId": "<string>",
    "mergedGcsPath": "<string>",
    "attachments": [
        {
            "gcsPath": "<string>",
            "filename": "<string>",
            "displayOrder": 0,
            "documentId": "<string>"
        }
    ],
    "phoneNumberId": "<string>",
    "patientId": "<string>"
}
headers = {
    "TENANT": "<tenant>",
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    faxContactId: '<string>',
    mergedGcsPath: '<string>',
    attachments: [
      {
        gcsPath: '<string>',
        filename: '<string>',
        displayOrder: 0,
        documentId: '<string>'
      }
    ],
    phoneNumberId: '<string>',
    patientId: '<string>'
  })
};

fetch('https://api.decodahealth.com/faxes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.decodahealth.com/faxes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'faxContactId' => '<string>',
    'mergedGcsPath' => '<string>',
    'attachments' => [
        [
                'gcsPath' => '<string>',
                'filename' => '<string>',
                'displayOrder' => 0,
                'documentId' => '<string>'
        ]
    ],
    'phoneNumberId' => '<string>',
    'patientId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "Content-Type: application/json",
    "TENANT: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.decodahealth.com/faxes"

	payload := strings.NewReader("{\n  \"faxContactId\": \"<string>\",\n  \"mergedGcsPath\": \"<string>\",\n  \"attachments\": [\n    {\n      \"gcsPath\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"displayOrder\": 0,\n      \"documentId\": \"<string>\"\n    }\n  ],\n  \"phoneNumberId\": \"<string>\",\n  \"patientId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TENANT", "<tenant>")
	req.Header.Add("API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/faxes")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"faxContactId\": \"<string>\",\n  \"mergedGcsPath\": \"<string>\",\n  \"attachments\": [\n    {\n      \"gcsPath\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"displayOrder\": 0,\n      \"documentId\": \"<string>\"\n    }\n  ],\n  \"phoneNumberId\": \"<string>\",\n  \"patientId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/faxes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"faxContactId\": \"<string>\",\n  \"mergedGcsPath\": \"<string>\",\n  \"attachments\": [\n    {\n      \"gcsPath\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"displayOrder\": 0,\n      \"documentId\": \"<string>\"\n    }\n  ],\n  \"phoneNumberId\": \"<string>\",\n  \"patientId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "signalwireFaxSid": "<string>",
  "phoneNumberId": "<string>",
  "phoneNumberE164": "<string>",
  "faxContact": {
    "id": "<string>",
    "name": "<string>",
    "faxNumber": "<string>",
    "organization": "<string>",
    "notes": "<string>",
    "addressLineOne": "<string>",
    "addressLineTwo": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "createdByUserId": "<string>"
  },
  "numPages": 123,
  "cost": "<string>",
  "errorCode": "<string>",
  "errorMessage": "<string>",
  "pdfPath": "<string>",
  "sentAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "createdByUserId": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "patientId": "<string>",
  "patient": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "filedDocument": {
    "id": "<string>",
    "title": "<string>",
    "docType": "<string>"
  },
  "readDate": "2023-11-07T05:31:56Z",
  "attachments": [
    {
      "id": "<string>",
      "filename": "<string>",
      "gcsPath": "<string>",
      "displayOrder": 123,
      "documentId": "<string>"
    }
  ],
  "analysis": {
    "errorMessage": "<string>",
    "extraction": {
      "patientFirstName": "<string>",
      "patientLastName": "<string>",
      "patientDateOfBirth": "<string>",
      "patientPhone": "<string>",
      "patientMrn": "<string>",
      "requestingProviderName": "<string>",
      "documentCategory": "<string>",
      "summary": "<string>",
      "keySections": [
        {
          "heading": "<string>",
          "content": "<string>"
        }
      ],
      "suggestedDocumentTitle": "<string>",
      "suggestedDocType": "<string>",
      "suggestedNoteTemplateId": "<string>"
    },
    "suggestedPatient": {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "patientMatchReason": "<string>",
    "suggestedTemplate": {
      "id": "<string>",
      "name": "<string>"
    },
    "suggestedProvider": {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "createdNoteId": "<string>",
    "createdTaskId": "<string>",
    "patientSuggestionDismissedAt": "2023-11-07T05:31:56Z",
    "noteSuggestionDismissedAt": "2023-11-07T05:31:56Z",
    "taskSuggestionDismissedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

faxes

Send Fax

curl --request POST \
  --url https://api.decodahealth.com/faxes \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "faxContactId": "<string>",
  "mergedGcsPath": "<string>",
  "attachments": [
    {
      "gcsPath": "<string>",
      "filename": "<string>",
      "displayOrder": 0,
      "documentId": "<string>"
    }
  ],
  "phoneNumberId": "<string>",
  "patientId": "<string>"
}
'

import requests

url = "https://api.decodahealth.com/faxes"

payload = {
    "faxContactId": "<string>",
    "mergedGcsPath": "<string>",
    "attachments": [
        {
            "gcsPath": "<string>",
            "filename": "<string>",
            "displayOrder": 0,
            "documentId": "<string>"
        }
    ],
    "phoneNumberId": "<string>",
    "patientId": "<string>"
}
headers = {
    "TENANT": "<tenant>",
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    faxContactId: '<string>',
    mergedGcsPath: '<string>',
    attachments: [
      {
        gcsPath: '<string>',
        filename: '<string>',
        displayOrder: 0,
        documentId: '<string>'
      }
    ],
    phoneNumberId: '<string>',
    patientId: '<string>'
  })
};

fetch('https://api.decodahealth.com/faxes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.decodahealth.com/faxes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'faxContactId' => '<string>',
    'mergedGcsPath' => '<string>',
    'attachments' => [
        [
                'gcsPath' => '<string>',
                'filename' => '<string>',
                'displayOrder' => 0,
                'documentId' => '<string>'
        ]
    ],
    'phoneNumberId' => '<string>',
    'patientId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "Content-Type: application/json",
    "TENANT: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.decodahealth.com/faxes"

	payload := strings.NewReader("{\n  \"faxContactId\": \"<string>\",\n  \"mergedGcsPath\": \"<string>\",\n  \"attachments\": [\n    {\n      \"gcsPath\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"displayOrder\": 0,\n      \"documentId\": \"<string>\"\n    }\n  ],\n  \"phoneNumberId\": \"<string>\",\n  \"patientId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TENANT", "<tenant>")
	req.Header.Add("API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/faxes")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"faxContactId\": \"<string>\",\n  \"mergedGcsPath\": \"<string>\",\n  \"attachments\": [\n    {\n      \"gcsPath\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"displayOrder\": 0,\n      \"documentId\": \"<string>\"\n    }\n  ],\n  \"phoneNumberId\": \"<string>\",\n  \"patientId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/faxes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"faxContactId\": \"<string>\",\n  \"mergedGcsPath\": \"<string>\",\n  \"attachments\": [\n    {\n      \"gcsPath\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"displayOrder\": 0,\n      \"documentId\": \"<string>\"\n    }\n  ],\n  \"phoneNumberId\": \"<string>\",\n  \"patientId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "signalwireFaxSid": "<string>",
  "phoneNumberId": "<string>",
  "phoneNumberE164": "<string>",
  "faxContact": {
    "id": "<string>",
    "name": "<string>",
    "faxNumber": "<string>",
    "organization": "<string>",
    "notes": "<string>",
    "addressLineOne": "<string>",
    "addressLineTwo": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "createdByUserId": "<string>"
  },
  "numPages": 123,
  "cost": "<string>",
  "errorCode": "<string>",
  "errorMessage": "<string>",
  "pdfPath": "<string>",
  "sentAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "createdByUserId": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "patientId": "<string>",
  "patient": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "filedDocument": {
    "id": "<string>",
    "title": "<string>",
    "docType": "<string>"
  },
  "readDate": "2023-11-07T05:31:56Z",
  "attachments": [
    {
      "id": "<string>",
      "filename": "<string>",
      "gcsPath": "<string>",
      "displayOrder": 123,
      "documentId": "<string>"
    }
  ],
  "analysis": {
    "errorMessage": "<string>",
    "extraction": {
      "patientFirstName": "<string>",
      "patientLastName": "<string>",
      "patientDateOfBirth": "<string>",
      "patientPhone": "<string>",
      "patientMrn": "<string>",
      "requestingProviderName": "<string>",
      "documentCategory": "<string>",
      "summary": "<string>",
      "keySections": [
        {
          "heading": "<string>",
          "content": "<string>"
        }
      ],
      "suggestedDocumentTitle": "<string>",
      "suggestedDocType": "<string>",
      "suggestedNoteTemplateId": "<string>"
    },
    "suggestedPatient": {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "patientMatchReason": "<string>",
    "suggestedTemplate": {
      "id": "<string>",
      "name": "<string>"
    },
    "suggestedProvider": {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "createdNoteId": "<string>",
    "createdTaskId": "<string>",
    "patientSuggestionDismissedAt": "2023-11-07T05:31:56Z",
    "noteSuggestionDismissedAt": "2023-11-07T05:31:56Z",
    "taskSuggestionDismissedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Body

application/json

Compose-and-send for an outbound fax.

The browser merges the cover sheet + attachments locally and uploads the final PDF; merged_gcs_path points at that blob, which the server validates and forwards to SignalWire as-is. attachments is still sent for provenance — each row records the source document a page came from.

faxContactId

string

required

mergedGcsPath

string

required

Required string length: 1 - 500

attachments

FaxAttachmentInput · object[]

required

Minimum array length: 1

Show child attributes

phoneNumberId

string | null

patientId

string | null

Response

Successful Response

string

required

direction

enum<string>

required

Direction of a fax. INBOUND is defined now so inbound work later just adds rows.

Available options:

OUTBOUND,

INBOUND

status

enum<string>

required

Lifecycle status of a fax. Values mirror SignalWire's LaML fax status values.

Available options:

QUEUED,

SENDING,

DELIVERED,

FAILED,

CANCELED,

NO_ANSWER,

BUSY

signalwireFaxSid

string | null

required

phoneNumberId

string | null

required

phoneNumberE164

string | null

required

faxContact

FaxContactResponse · object | null

required

Show child attributes

numPages

integer | null

required

cost

string | null

required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

errorCode

string | null

required

errorMessage

string | null

required

pdfPath

string | null

required

sentAt

string<date-time> | null

required

completedAt

string<date-time> | null

required

createdByUserId

string | null

required

createdDate

string<date-time>

required

updatedDate

string<date-time> | null

required

patientId

string | null

patient

LinkedPatientRef · object | null

Minimal patient reference for a fax linked to a chart (id + name only).

Lets the detail pane show "Linked to {name}" and the create-task dialog pre-fill the patient without a second fetch.

Show child attributes

filedDocument

LinkedDocumentRef · object | null

Minimal reference to the chart document a fax is filed to (id + current title + type). Lets the link dialog seed its fields with what's actually filed instead of opening blank, so re-confirming/relinking preserves them unless the user edits — no clobber from resent defaults.

Show child attributes

readDate

string<date-time> | null

attachments

FaxAttachmentResponse · object[]

Show child attributes

analysis

FaxAnalysisResponse · object | null

The AI analysis surface on the fax detail: status + the three suggest-only cards (patient link / note / provider task).

extraction is the raw LLM output (summary, key sections, as-printed identity, title/type hints); the suggested_* refs are the deterministically matched rows staff can accept. *_dismissed_at timestamps hide a card without deleting the underlying data.

Show child attributes

Getting Started

API Guides

Patient Management

Billing & Payments

Catalog & Inventory

Growth

Clinical & Scheduling

Communications

Platform

Headers

Body

Response