| type |
String |
The annotation type (e.g., "Signature", "Initials", "DateSigned", "Text", "Checkbox"). |
[default to null] |
| roleName |
String |
The name of the role this annotation is assigned to. |
[default to null] |
| pageNumber |
Integer |
The 1-based page number where this annotation is placed. |
[default to null] |
| x |
Double |
The X coordinate of the annotation's top-left corner in PDF points (1pt = 1/72 inch). 0 = left edge of page. US Letter page width is 612 points; A4 is 595. |
[default to null] |
| y |
Double |
The Y coordinate of the annotation's top-left corner in PDF points. 0 = top edge of page. US Letter page height is 792 points; A4 is 842. |
[default to null] |
| width |
Double |
The width of the annotation in PDF points. Typical ranges: Signature 140-200, Initials 60-90, FullName 150-200, Email 180-240, Title/Company 120-180, Date/DateSigned 80-120, Text 100-200, Checkbox 14-18, Dropdown/RadioGroup 100-180, Note 120-200. |
[default to null] |
| height |
Double |
The height of the annotation in PDF points. Typical ranges: Signature 35-50, Initials 30-45, all text-style fields (FullName/Email/Title/Company/Date/Text) 16-22 to match a single line of body text, Checkbox 14-18, Dropdown/RadioGroup 18-22, Note 24-40. |
[default to null] |
| required |
Boolean |
Whether the signer is required to complete this annotation. Defaults to true. |
[optional] [default to null] |
| label |
String |
An optional display label shown to the signer. |
[optional] [default to null] |
| group |
String |
An optional group name for radio button or checkbox groups. |
[optional] [default to null] |
| options |
List |
A list of selectable options for dropdown or radio button annotations. |
[optional] [default to null] |
| defaultValue |
String |
A default value pre-filled into the annotation field. |
[optional] [default to null] |
| signerIndex |
Integer |
|
[optional] [default to null] |