Signature Fields
Field Properties
| Name | Description | Type / Format |
|---|---|---|
| id | The unique identifier of the field. | string |
| name | The name provided for the provided by the source system. | string |
| type | The field type indicating how it should behave - more information below.
| string |
| page | The page number contains the document field. | number |
| top | The document field top, offset from document origin. | number |
| right | The document field right, offset from document origin. | number |
| bottom | The document field bottom, offset from document origin. | number |
| left | The document field left, offset from document origin. | number |
| scale | The scale of the document field - a value between .5 and 2 representing the percentage scale from the default size. example: .5 is 50% or half of the normal size. Not all fields support scale see notes on individual types and behavior. | number |
| optional | Sets a value used to determine wether a field may be skipped by the signer.
| boolean |
| conditionalField | Represents a reference to another field and the value that this field is conditioned upon. The field will only be available to sign if the condition matches. A field is never required if not available to sign. | object |
| conditionalField.id | The identity of the field availability is dependent upon. | string |
| conditionalField.value | The value of the dependent field that is expected to make this field available. Must be a valid value for the dependent field.
| object |
| validationField | The details for validation of the signer input. Currently only support for Date type. | object |
| validationField.pattern | Validation pattern for Date type can be:
| string |
| validationField.message | Validation message that will be displayed to user if date is not in correct form. | string |
| itemType | The type of the item fields for the group.
| string |
| itemFields | The grouped item fields, only valid and required for grouped field types like RadioGroup and CheckGroup. | object |
| itemFields.name | The name of the item field that this recipient must sign. | string |
| itemFields.top | The item field top, offset from document origin. | number |
| itemFields.right | The item field right, offset from document origin. | number |
| itemFields.bottom | The item item bottom, offset from document origin. | number |
| itemFields.left | The item field left, offset from document origin. | number |
| itemFields.page | The page number contains the item field. | number |
| itemFields.value | The value this item field represents when selected. | string |
| value | This will be populated for the Note with text intended for signer. | string |
Field Positioning
All positions coordinates are provided as a box in points (72 points per inch) with the document origin as the top/left of each page.
Example
top: 72, left: 72, right: 144, bottom: 144
This designated space will be:
1 inch down (top side of the box is 72 points from top of the page)
1 inch right (left side of the box is 72 points from left of the page)
1 inch high (bottom side of the box is 144 points from top of the page)
1 inch wide (right side of the box is 144 points from left of the page)
The fields presentation is expected to also have a top/left origin within this space, the field box, the rest of the space is available to be used but does not have to be filled.
Overflowing the space may be needed in certain circumstances but is generally not the recommended approach and risks making the document invalid.
Individual field types have specific expectations and recommendations for behavior that will be documented with those types.
Scaled Fields
The scale property is supported for certain signature style fields and itemFields (Signature, Initials, SignAndDate).
Scale applies a modifier to the standard dimensions expected.
Example
A scale of .5 (e.g. 50%) and a height of 32 is expected to result in an actual height of 16.
Grouped Fields
The grouped fields (RadioGroup and CheckGroup) represent a group of related fields tied to an actual data point.
The itemFields represent the important related fields that must actually be presented to the recipient.
The root position provided should provide an indicator of the overall space usage but may generally be ignored.
Auto-Poulated Fields
These fields are populated by the signing system not the signer.
Optional Fields
All fields are required by default though any field may be flagged as optional.
While the property may be set it should be ignored for auto-populated fields.
Conditional Fields
Conditional fields only show if the set condition evaluates to true.
If the condition is not true the field should no longer appear or be available for change.
If the condition is not met when the document is completed by the signer it must not be considered as being populated even if the signer had done so.
Examples:
- A radio group could have item fields with values yes, no, and other.
A text field with the conditionalField populated with the radio group field id and value of other must appear when the radio button associated with the other item field is selected. - A required text field can be conditioned on an optional signature with the value of false and it must be available initially but no longer be available if the signer completes the signature.
Field Types
Signature
The visual markers of a recipients signature.
It is acceptable to:
- generate the signature providing font choices that a user can adopt.
- allow the user to draw a signature
- allow a user to upload the signature image
Format: image
Size:
Height: 32
Width: dynamic/wrap
Scales
Optional: supported
Condition: supported / boolean - signed is true
SignedDate
The date the document was signed captured by the signing system.
Format: text / date / ?
Size: Fixed
Height:
Width:
Font: Arial 7
Optional: n/a
Condition: n/a
Auto-Populated
SignAndDate
The visual markers of a recipients signature and the signed date.
The signed date is expected to appear right/bottom aligned in the field box.
The signature is expected to appear top/left aligned in the field box.
It is acceptable to:
- generate the signature providing font choices that a user can adopt.
- allow the user to draw a signature
- allow a user to upload signature image
Format: Composite
Size:
Scales - only signature portion
Optional: supported
Conditional: supported / boolean - signed is true
Initials
Similar to signature but expected to be the initials of the signer.
Format: Image
Size:
Height: 32
Width: dynamic/wrap
Scales
Optional: supported
Condition: supported / boolean - initialed is true
Checkbox
Expected to be a square widget that checks when clicked and clears if clicked again.
Size: fixed
Height: 9
Width: 9
Optional: supported
Condition: supported / boolean - checked is true
Text
Allows the signer to enter general text.
Size: field box
Height: minimum 9 pts should be used for actual display
if greater than 9 should be considered multi-line text box
each line should be 9 pts
Font: Arial 7
Optional: supported
Condition: supported / value
Date
A date in the format provided in the validationField property.
Size: field box
Font: Arial 7
Optional: supported
Condition: supported / boolean - signed is true
RadioGroup
A radio group indicates the recipient must select only one of the provided data values from the itemFields. The selected value is current value of the field.
Size: (each item field)
Height: 9
Width: 9
Optional: supported
Condition: supported / boolean - value
CheckGroup
A radio group indicates the recipient may select multiple of the provided data values from the itemFields. The selected value(s) are the current value of the field.
Size: (each item field)
Height: 9
Width: 9
Optional: supported
Condition: supported / boolean - value
Note
Provides a note for the signer to appear only during signing - it must not be on the signed document. A mechanism should be provided for the user to hide / show the note.
Size: field box
Optional: n/a
Condition: n/a
Auto-Populated
Updated over 1 year ago