The field object

Attributes

• id integer

The field identifier.

• role integer

The role identifier.

• type string

The type of field can be date, text, email, checkbox, radio, signature, paraph, title, company, fullName or address.

• label string

Human readable type representation.

• documentId integer

The id of the document where the field is localized.

• page integer

The page number where the field is localized.

• value string

An optional value can be attached to a field, depending of the field type.

• posX string

The horizontal relative position (in %) in the page.

• posY string

The vertical relative position (in %) in the page.

• style object

An object representing the style of the field in the document.

Example

{
    "id": 1,
    "role": 1,
    "type": "signature",
    "label": "Signature",
    "documentId": 1,
    "page": 1,
    "value": null,
    "posX": 34.96,
    "posY": 40.62,
    "style":{
        "color": "#000000",
        "fontStyle": "Arial",
        "fontSize": 11,
        "width":2 9.92,
        "height": 10.57,
        "bold": false,
        "italic": false,
        "underline": false
    }
}