SignatureAPI now supports Checkbox Places. You can place interactive checkboxes anywhere in a document and capture whether a recipient checked them, alongside signatures, initials, and other inputs.
What It Does
A checkbox place marks a specific location in a document where a recipient can check or uncheck a box during the signing ceremony. Each checkbox is assigned to a recipient through recipient_key and positioned using either a [[place_key]] placeholder in the document or an entry in fixed_positions.
You can configure the symbol shown when the box is checked using the symbol property. Two options are available, check for a checkmark (the default) and xmark for an X. The height property sets the size of the box in points, between 8 and 40, and the width matches the height.
Checkboxes can be required or optional. Required checkboxes must be checked before the recipient can complete the ceremony.
Capturing Input
Set capture_as to store the result in the envelope’s captures object. After the envelope is completed, you can retrieve whether the box was checked as a boolean value under the key you specified.
{
"key": "postal_address_delivery",
"type": "checkbox",
"symbol": "check",
"recipient_key": "policy_holder",
"capture_as": "postal_address_delivery",
"requirement": "optional"
}Checkbox places are particularly useful for opt-in consents, acknowledgments, and delivery preferences that need to be recorded as part of the signed record.
For more details, see the Checkbox Place documentation.
