API Reference
API Reference

/extract (form)

post deprecated
https://{endpoint}/extract
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Form ID

file

The image file, can be a JPG, PNG or PDF file Either specify this or provide the image_url parameter

string

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

number
Defaults to 150

DPI of the uploaded pdf file

string
enum

OCR Engine

Allowed:
string

original file name

string
enum
Defaults to false

Flag for using the asynchronous mode

Allowed:
string
Defaults to false

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

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

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:
string
enum
Defaults to false

Flag for returning OCR result in the response.

Allowed:
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

string
enum
Defaults to false

Flag for showing confidence score in response

Allowed:
string
enum
Defaults to false

Flag for including request_id in the response

Allowed:
Responses

Updated 3 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago