Checkbox Field API

This document contains the Checkbox field API format and a list of supported attributes.

Checkbox field
<field type=”checkbox” name=”string” roleId=”id” search=”boolean” optional=”boolean”/>

Checkbox Field attributes

• type — define if this field is checkbox type, mandatory attribute.

• name — string, length from 1 up to 128 symbols, restricted symbols &, “, <, >, field name used to fill in on envelope, unique for document, mandatory attribute.

• roleId — id of the role who should fill field on envelope, mandatory attribute.

• search — boolean, defines if field is searchable on envelope search or not, if not set default value false, optional attribute.

• optional — boolean, defines if field to be filled in optionally or not on envelope, if not set default value false, optional attribute.