| id |
UUID |
Server-assigned GUID uniquely identifying this annotation. Use this value in GET, PUT, and DELETE operations. |
[default to null] |
| documentId |
UUID |
GUID of the document this annotation belongs to. |
[default to null] |
| signerIndex |
Integer |
Zero-based index of the signer assigned to complete this annotation. |
[default to null] |
| type |
String |
The annotation field type. One of: `Signature`, `Initials`, `DateSigned`, `Date`, `Text`, `Checkbox`, `RadioGroup`, `Dropdown`, `Number`, `Email`, `FullName`, `Company`, `Title`, `Attachment`, `Formula`, `Note`, `Approve`, `Decline`. |
[default to null] |
| pageNumber |
Integer |
1-based page number where the annotation is placed. |
[default to null] |
| x |
Double |
Horizontal position of the annotation's top-left corner in PDF points (1pt = 1/72 inch). 0 = left edge. |
[default to null] |
| y |
Double |
Vertical position of the annotation's top-left corner in PDF points. 0 = top edge. |
[default to null] |
| width |
Double |
Width in PDF points. |
[default to null] |
| height |
Double |
Height in PDF points. |
[default to null] |
| required |
Boolean |
Whether the signer must complete this field before finishing the signing ceremony. |
[default to null] |
| mustBeChecked |
Boolean |
For Checkbox type: whether the box must be checked (vs. just interacted with). Always returned but only meaningful for Checkbox annotations. |
[default to null] |
| label |
String |
Display label shown to the signer, or null if none was set. |
[default to null] |
| group |
String |
Group identifier for logically related annotations (e.g., RadioGroup members), or null. |
[default to null] |
| defaultValue |
String |
Pre-filled value for the field, or null if none was set. |
[default to null] |
| completedValue |
String |
The value entered or selected by the signer during the signing ceremony. Null if the annotation has not been completed. For Signature/Initials, contains the signature image reference. For Checkbox, contains "true" or "false". |
[default to null] |
| isCompleted |
Boolean |
Whether the signer has completed this annotation in the signing ceremony. |
[default to null] |
| completedOn |
Date |
UTC timestamp of when the signer completed this annotation, or null if not yet completed. |
[default to null] |
| options |
List |
List of selectable values for Dropdown and RadioGroup types. Null for other annotation types. |
[default to null] |
