Skip to main content
An Image field lets you save parts of documents as pictures — for example, identity photos, signatures, or stamps.

​
Add an Image field

Click Add Image in the toolbar. A new Image field appears in the data form.
Image fields cannot be trained. For every document with an Image field, you must set the image region during manual review or via a Custom activity script.
An Image field cannot have more than one region. To extract multiple images, enable Allow multiple items and add one image per instance.

​
General properties

​
Access extracted images

During data export, Vantage extracts each image using its region coordinates and saves it as a JPG. You can access extracted images the same way as other extracted data:
  • Vantage API — Retrieve extracted images alongside other field values.
  • Custom activity or Output activity scripts — The Field object exposes Value (the filename) and Image (the binary contents).
  • Shared folder export (Output activity) — The JSON export includes the image filename in each image field’s value key. Image files are placed in a subfolder named after the JSON file.

​
File naming

During export, Vantage names each image file based on the field and its position in the skill hierarchy:
If the resulting filename would exceed 256 characters (including separators, instance numbers, and the .jpg extension), Vantage falls back to Field_{guid}.jpg, where {guid} is the GUID of the image field.