Checkbox places in SignatureAPI now support a requirement attribute. Setting it to required forces the signer to check the box before they can complete the ceremony, making it easy to enforce explicit consent or acceptance of terms.
What It Does
The requirement attribute accepts two values, required or optional, and defaults to optional. When a checkbox is required, the recipient cannot finish their signing action until the box is checked. Existing checkboxes keep their current behavior unless you opt in to the new attribute.
Combine requirement with capture_as to both enforce and record consent. The captured value lands in the envelope’s captures object once the envelope is completed, ready to be read back through the API.
How to Use It
Add requirement: "required" to any checkbox place in your envelope payload:
{
"key": "accept_terms",
"type": "checkbox",
"recipient_key": "client",
"requirement": "required",
"capture_as": "accepted_terms"
}Checkbox places are available in envelopes with sequential signing, and can be positioned using placeholders or fixed positions just like any other place type.
For full details, see the Checkbox Place docs.
