Interface: TemplateSignerInput

TemplateSignerInput

Template Signer Input Input created by a Signer on a Template
Source:

Members

content_type :'signature'|'initial'|'stamp'|'date'|'checkbox'|'text'|'full_name'|'first_name'|'last_name'|'company'|'title'|'email'|'attachment'|'radio'|'dropdown'

Content type of input Example: text
Type:
  • 'signature' | 'initial' | 'stamp' | 'date' | 'checkbox' | 'text' | 'full_name' | 'first_name' | 'last_name' | 'company' | 'title' | 'email' | 'attachment' | 'radio' | 'dropdown'
Source:

coordinates :object

Where the input is located on a page.
Type:
  • object
Source:

dimensions :object

The size of the input.
Type:
  • object
Source:

document_id :string

Document identifier. Example: 123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7
Type:
  • string
Source:
When the input is of the type `dropdown` this values will be filled with all the dropdown options. Example: Yes,No,Maybe
Type:
  • Array
Source:

group_id :string

When the input is of type `radio` they can be grouped to gather with this identifier. Example: da317330-225a-4c72-89ad-0d6dcaaf4df6
Type:
  • string
Source:

is_required :boolean

Whether or not the input is required. Example: true
Type:
  • boolean
Source:

label :string

The label field is used especially for text, attachment, radio, and checkbox type inputs. Example: Legal name
Type:
  • string
Source:

page_index :number

Index of page that the input is on. Example: 4
Type:
  • number
Source:

read_only :boolean

Whether this input was defined as read-only(immutable by signers) or not Example: true
Type:
  • boolean
Source:

type :'signature'|'date'|'text'|'checkbox'|'attachment'|'radio'|'dropdown'

Type of input Example: text
Type:
  • 'signature' | 'date' | 'text' | 'checkbox' | 'attachment' | 'radio' | 'dropdown'
Source: