Jump to Content

Home Guides API Reference Changelog

v3.0

API Reference Log In

API Reference

v3.0

All

Pages

Start typing to search…

etherFAX REST API 3.0

Introduction
Authentication

ACCOUNTS

/accountsget
/accounts/pkinfopost

OUTBOX

/outboxpost
/outbox (pending)get

INBOX

/inbox (unread)get
/inbox (list)get
/inbox (get)get
/inbox (getnext)get
/inbox (received)get

STATUS

/statusget
/statuspost

ROUTES

/routes (info)get
/routes (list)get
/routes (parse)get
/routes (enable | disable)get

DEVICES

/devices (unread)get
/devices (list)get
/devices (status)get
/devices (actionreset)get
/devices (setaddr)get
/devices (setconfig)get
/devices (register)get
/devices/pkinfopost

MODELS

DeviceActions
DeviceEnrollment
DeviceEnrollmentResult
FaxAccount
FaxDevice
FaxReceive (DocumentParams)
FaxResult
FaxSend
FaxSendOptions
FaxState
FaxStatus
PendingFaxResult
RouteInfo (EncryptionParams)
TransactionType
UnreadFaxResult

FORMS RECOGNIZER

AnalyzeFormResult
AnalyzeResult
DocumentResultsItem
PageResultsItem
ReadResultsItem

Powered by

AnalyzeFormResult

Container for all OCR, page, and document results as well as the overall status.