Skip to main content
POST
Extract OCR and NLP data
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 200 response has separate shortened OCR and NLP examples. OCR returns an array of detected blocks in data.json_text; NLP returns a structured object. See OCR and NLP response formats.

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 whose extracted data is returned.

direction
enum<string>
required

Direction of the fax whose extracted data is returned.

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

Case-sensitive extraction type.

Available options:
OCR,
NLP

Response

200 - application/json

The requested OCR or NLP data was retrieved successfully. This example shows an NLP response; OCR returns a different json_text shape.

status
integer
required
message
string
required
data
object
required