Skip to main content
PATCH
/
accounts
/
{user_id}
/
faxes
/
{fax_id}
/
ai
/
field-extraction
Update extracted fields
curl --request PATCH \
  --url https://restapi.fax.plus/v3/accounts/{user_id}/faxes/{fax_id}/ai/field-extraction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "sender_name": "Jane Doe",
    "sender_company": "Acme Corporation",
    "date": "2026-01-15"
  }
}
'
{
  "status": "finished",
  "data": {
    "sender_name": "John Doe",
    "sender_company": "Acme Corp",
    "date": "2026-01-15",
    "reference_number": "INV-2026-001"
  }
}

Authorizations

​
Authorization
string
header
required

OAuth2 Authorization Grant

Path Parameters

​
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

Body

application/json

Request to update extracted field data with user corrections

​
data
object
required

Updated field data as key-value pairs

Response

Response containing field extraction status and result

Field extraction result for a fax

​
status
enum<string>
required

Field extraction processing status

Available options:
not_requested,
pending,
finished,
failed,
content_filtering_policy
​
data
object

Extracted fields as key-value pairs. Null when status is not finished