Skip to content

DocumentFields Object

Properties

created_atstring · date-time

The date and time when the document field was created

documentobject

The document on which the field is found

idstring

The unique identifier for the document

page_numberstring

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

positionobject
2 properties
xstring

The X-axis coordinate position for the field

ystring

The Y-axis coordinate position for the field

idstring

The unique identifier for the document field

is_read_onlyboolean

Specifies if the field can be edited by the participants

is_requiredboolean

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

labelstring

Human readable name for the field

participantobject

The participant who needs to fill this field

idstring

The unique identifier of the participant

remote_dataRecord<string, any>

Raw data returned from the remote API call.

signing_requestobject

The signing request on which the field is found

idstring

The unique identifier for the signing request

typestring

The type of the field

Possible values:
signatureinitialsfull_namesigning_datecompany_nametitletextemail
updated_atstring · date-time

The date and time when the document field was updated