What is a Checkbox?

A Checkbox allows Signers to select or deselect an option in a Document.

Unlike Radio Group, which enforces a single Radio selection within a Group, Checkboxes are independent and allow for multiple selections, making them ideal for forms where Signers need to select multiple preferences or confirm various conditions.

Checkbox creation

Before jumping to the creation options, let’s review the main characteristics of a Checkbox:

Parameters	Descriptions
`optional`	• Define if the selecting a Checkbox is optional or not. • Defaults to false and is optional.
`checked`	• Default value of the Checkbox. • Defaults to false (unchecked) and is optional.
`size`	• Size in pixels of the Checkbox • From 8px to 240px, defaults to 24px.
`name`	Name of the Field. Optional.
`read_only`	Define if the value of the Field can be edited by the Signer. It can only be set to true if checked is true. Defaults to false and is optional.

Checkbox creation with Smart Anchors

Smart Anchors allow you to insert a Checkbox within your document using this pattern:

Pattern: {{signer_index|checkbox|size|optional|checked|name}}
Example: {{s1|checkbox|24|t|f|Checkbox1}}

The Signers index (s1, s2, s3, etc) is determined by the Signers order in the Signature Request. If the index references a non-existent Signer, the Field won’t be created.

Checkbox creation with API endpoints

To create a Checkbox using the API endpoints, you have two options:

Create a Signer and a Checkbox at the same time using this endpoint:/POST /signature_requests/{signatureRequestId}/signers
Add a Checkbox to an existing Signer using this endpoint:/POST /fields/{signatureRequestId}/documents/{documentId}/fields

Retrieve the Checkbox value once filled by the Signer

To check whether a Signer has selected a Checkbox, follow these steps:

Fetch the Checkbox Field thanks to its name using this endpoint:/GET /signature_requests/{signatureRequestId}/documents/{documentId}/fields&signer_id[eq]=500800fc-3f91-4e86-a9c9-866809a1e3c9s&type[eq]=checkbox&name[eq]=Checkbox1.