Skip to main content
POST
Request OCR and NLP processing
Provide the required job_id, direction, and type fields. Set direction to inbound or outbound. The type value is case-sensitive and accepts OCR or NLP. Authenticate with a Bearer access token.
The current API returns Fax NLP request submitted successfully after both OCR and NLP submissions. For OCR requests, use the HTTP status and status field to determine success.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
job_id
string
required

Unique identifier of the fax to process.

direction
enum<string>
required

Direction of the fax being processed.

Available options:
inbound,
outbound
type
enum<string>
required

Case-sensitive processing type.

Available options:
OCR,
NLP

Response

200 - application/json

The OCR or NLP processing request was submitted successfully.

status
integer
required
message
string
required