A Checkbox Place is a type of Place that marks a specific area in the document where the recipient, as identified by the recipient_key, can check a box.

You can position Checkbox Places inside a document using either fixed positions or placeholders.

​
Example

For example, this is a definition of a checkbox place for the recipient with key employee:

"documents":
[
  {
    ...
    "places": [
      {
        "key": "receive_marketing_emails",
        "type": "checkbox",
        "recipient_key": "employee",
        "symbol": "check"
      }
    ]
    ...
  }
]

​
Parameters

​
type
enum
required

Specifies the type of place.

For a checkbox place, the value must be checkbox.

​
key
string
required

A user-provided key that identifies a place within a document.

It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.

​
recipient_key
string
required

A user-provided key that identifies a recipient within an envelope.

It must match to one of the keys in the envelope’s recipient list.

​
capture_as
string

A user-defined identifier used to store the value entered by the recipient. This value will be included in the captures object of the Envelope.

​
symbol
enum

The symbol to display in the checkbox when it is checked.

Available options are check and xmark. The default is check.