/extract (header)

post deprecated

https://{endpoint}/extract

Body Params

Headers

X-WORKER-FORM-ID

string

required

Form ID

X-WORKER-IMAGE-URL

string

URL of the image to be processed in jpg or png format, or URL of a pdf file

X-WORKER-ENCODING

string

enum

Defaults to raw

Encoding of the request body, allowed raw or base64

Allowed:

X-WORKER-PDF-DPI

number

Defaults to 150

DPI of the uploaded pdf file

X-WORKER-OCR-ENGINE

string

enum

OCR Engine

Allowed:

X-WORKER-ORIGINAL-FILE-NAME

string

original file name

X-WORKER-ASYNC

string

enum

Defaults to false

Flag for using the asynchronous mode

Allowed:

X-WORKER-SHOULD-MULTI-PAGE-PDF

string

Defaults to false

Flag for processing all pages in a PDF file. If "false", only the first page is proccessed.

X-WORKER-SHOULD-DETECT-MULTI-DOCUMENT

string

Defaults to false

Flag for detecting multiple documents in a page. Turn this on if more than one documents are in each page. For example, 3 identity cards in a scan

X-WORKER-AUTO-ADJUST-IMAGE-SIZE

string

enum

Defaults to true

Flag for auto adjusting image size for better extraction result, it will take a longer for extraction if enabled

Allowed:

X-WORKER-OUTPUT-OCR

string

enum

Defaults to false

Flag for returning OCR result in the response.

Allowed:

X-WORKER-EXTRA-DATA

string

length ≤ 2048

Pass extra data as ASCII string to FormX. For structured data, consider represent it as JSON. For string containing non-ASCII string, consider encode it with base64

X-WORKER-SHOW-CONFIDENCE

string

enum

Defaults to false

Flag for showing confidence score in response

Allowed:

X-WORKER-RETURN-REQUEST-ID

string

enum

Defaults to false

Flag for including request_id in the response

Allowed:

Responses

200Success

202Accepted async extraction

4XXFailure