Overview

Send the image with a POST request to the Extract API endpoint and FormX will recognize the information from the document.

FormX will use the extractor of your choice to extract and return the data in a JSON format. The extractor can be specified by the extractor_id parameter. An Access Token should also be included. They can be obtained from the web portal dashboard.

Image Sizing Recommendations

The images submitted to the extraction API should be of sufficient size so that the text and features can be easily distinguished. To obtain the best results, it is recommended to use an image where each side is between 1000 and 2000 pixels, or a minimum of 100 DPI.

Common image file types such as JPEG, PNG, PDF are supported. For the full list, please check out our guide Here.

Limits

The file size limit of the image is 10MB if you upload the file via body param.

If you provide the file via image_url, there's no file size limit.

The image dimension limit is 10,000 pixels on one side and total number of pixels < 75M, this applies to all upload methods.

Using the Asynchronous mode

If the request takes too long to complete, you can use the asynchronous mode to avoid timeout. This can be enabled by the X-WORKER-ASYNC parameter in the header.

Job ID

If the async job is successfully created, a 202 Accepted response will be returned with the job_id and request_id

202 Accepted 
{
    "job_id": "<string>",
    "request_id": "<string>",
    "status": "ok"
}

To get the extraction result, please refer to Get async extraction result