Trigger fax OCR

curl --request POST \
  --url https://restapi.fax.plus/v3/accounts/{user_id}/faxes/{fax_id}/ai/ocr \
  --header 'Authorization: Bearer <token>'

{
  "status": "finished",
  "data": "Dear John,\nPlease find attached the signed contract..."
}

POST

accounts

{user_id}

faxes

{fax_id}

ocr

Trigger fax OCR

curl --request POST \
  --url https://restapi.fax.plus/v3/accounts/{user_id}/faxes/{fax_id}/ai/ocr \
  --header 'Authorization: Bearer <token>'

{
  "status": "finished",
  "data": "Dear John,\nPlease find attached the signed contract..."
}

Authorization

string

header

required

OAuth2 Authorization Grant

user_id

string

default:self

required

User ID. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.

fax_id

string

required

The unique identifier of the fax

Response containing OCR processing status and result

OCR processing result for a fax

status

enum<string>

required

OCR processing status

Available options:

not_requested,

pending,

finished,

failed,

content_filtering_policy

data

string | null

Extracted text content. Null when status is not finished

⌘I