Appearance

DocumentFields Object ​


id
string

The unique identifier for the document field

label
string

Human readable name for the field

type
string

The type of the field

All possible enum values:
  • signature
  • initials
  • full_name
  • signing_date
  • company_name
  • title
  • text
  • email
is_read_only
boolean

Specifies if the field can be edited by the participants

is_required
boolean

Specifies if the field is required to be filled by the participants to complete the signing request

document
object

The document on which the field is found

id
string

The unique identifier for the document

page_number
string

The page number of which the field is found inside the document

position
object
x
string

The X-axis coordinate position for the field

y
string

The Y-axis coordinate position for the field

signing_request
object

The signing request on which the field is found

id
string

The unique identifier for the signing request

participant
object

The participant who needs to fill this field

id
string

The unique identifier of the participant

created_at
string · date-time

The date and time when the document field was created

updated_at
string · date-time

The date and time when the document field was updated

remote_data
object

Raw data returned from the remote API call.