processCheckmarkField Method

The method allows you to extract the value of a checkmark on an image. The method loads the image, creates a processing task for the image with the specified parameters, and passes the task for processing.

Customize the following request URL according to your application processing location:


The image file is transmitted in the request body. See the list of supported input formats.

fieldLevelRecognition profile is used for processing.

The result of recognition is returned in XML format. The values of checkmarks are "checked", "unchecked", or "corrected".

For details on task cost please see billing terms.


Parameter Is required Default value Description
region No "-1,-1,-1,-1" Specifies the region of the text field on the image. The coordinates of the region are measured in pixels relative to the left top corner of the image and are specified in the following order: left, top, right, bottom. By default, the region of the whole image is used.
checkmarkType No "empty" Specifies the type of the checkmark. It can be one of the following:
  • circle (checkmark in a circle)
  • empty (checkmark against an empty background)
  • square (checkmark in a square)
correctionAllowed No "false" This property set to true means that checkmark block can be selected and then corrected.
description No "" Contains the description of the processing task. Must contain no more that 255 characters.
pdfPassword No "" Contains a password for accessing password-protected images in PDF format.

Status codes and response format

General status codes and response format of the method are described in HTTP Status Codes and Response Formats.

Output file format

The output XML file has the following format:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<document xmlns="@link" xmlns:xsi="@link" xsi:schemaLocation="@link" version="1.0">
    <field left="0" top="0" right="199" bottom="100" type="checkmark">
        <value suspicious=”true”>checked</value>

Have more questions? Submit a request



Please sign in to leave a comment.