- If the document is a PDF that contains checkbox metadata, then Sensible preferentially uses the metadata to extract selection status.
- If there’s no metadata, Sensible falls back to Azure Form Recognizer’s checkbox detection. This detection uses OCR and machine learning and captures a wide range of checkbox formats.
Examples
Parameters
Note: For the full list of parameters available for this method, see Global parameters for methods. The following table shows parameters most relevant to or specific to this method.key | values | description |
---|---|---|
id (required) | nearestCheckbox | Sensible returns true for selected checkboxes and false for unselected checkboxes. |
position (required) | left, right | Defines the starting point for searching for the nearest selection mark. Sensible searches outward from this point in all directions. right specifies starting at the midpoint of the anchor line’s right boundary, and left specifies starting at the midpoint of the anchor line’s left boundary. |
offsetX | number in inches. default: 0 | Searches for a selection mark starting at a point offset from the point defined by the Position parameter. Positive values offset to the right, negative values offset to the left. |
offsetY | number in inches. default: 0 | Searches for a selection mark starting at a point offset from the point defined by the Position parameter. Positive values offset down the page, negative values offset up the page. |
Examples
The following example shows extracting the checkboxes that are nearest to their respective anchors. For a checkbox that is nearer to another line’s checkbox than to its own checkbox, the example shows using an Offset parameter to close the gap:JSON
The following image shows the example document used with this example config:

Example document | Download link |
---|
JSON