| documentId |
UUID |
GUID of the document within the package where the annotation will be placed. The document must already be uploaded and belong to the package specified in the route. |
[default to null] |
| signerIndex |
Integer |
Zero-based index identifying which signer in the package is responsible for completing this field. Must correspond to an existing signer in the package's signer list (e.g., 0 for the first signer, 1 for the second). |
[default to null] |
| type |
String |
The annotation field type. Case-insensitive. Valid values: `Signature`, `Initials`, `DateSigned`, `Date`, `Text`, `Checkbox`, `RadioGroup`, `Dropdown`, `Number`, `Email`, `FullName`, `Company`, `Title`, `Attachment`, `Formula`, `Note`, `Approve`, `Decline`. |
[default to null] |
| pageNumber |
Integer |
The 1-based page number where the annotation should be placed. Must be a valid page within the document. |
[default to null] |
| x |
Double |
Horizontal position 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 |
Vertical position 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 |
Width in PDF points. Optional - when omitted, the server picks a sensible default scaled to the document's body-text size (recommended). If specifying, 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. Per-type server minimums are always enforced. |
[optional] [default to null] |
| height |
Double |
Height in PDF points. Optional - when omitted, the server picks a sensible default scaled to the document's body-text size (recommended). If specifying, 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. Per-type server minimums are always enforced. |
[optional] [default to null] |
| required |
Boolean |
Whether the signer must complete this field before finishing. Defaults to true if not specified. |
[optional] [default to null] |
| label |
String |
Optional display label shown to the signer (e.g., "Company Name", "Date of Birth"). Useful for providing context about what to enter. |
[optional] [default to null] |
| group |
String |
Optional group identifier for logically related annotations. Used with RadioGroup type to define mutually exclusive option sets - all RadioGroup annotations sharing the same Group value form one radio button group. |
[optional] [default to null] |
| defaultValue |
String |
Optional pre-filled value. For Text/Number/Email fields, this is the initial content. For Dropdown, this should match one of the Options values. For Checkbox, use "true" or "false". |
[optional] [default to null] |
| options |
List |
List of selectable values. Required for Dropdown and RadioGroup annotation types. Ignored for other types. |
[optional] [default to null] |
| anchorText |
String |
Text string to search for in the document for automatic positioning. When provided, the annotation is placed relative to where this text appears on the page, and explicit X/Y values serve as fallback. |
[optional] [default to null] |
| anchorOffsetX |
Integer |
Horizontal pixel offset from the anchor text position. Only used when AnchorText is provided. |
[optional] [default to null] |
| anchorOffsetY |
Integer |
Vertical pixel offset from the anchor text position. Only used when AnchorText is provided. |
[optional] [default to null] |
| mustBeChecked |
Boolean |
For Checkbox annotations only: whether the signer is required to check the box (not just interact with it). Defaults to true. Ignored for non-Checkbox types. |
[optional] [default to null] |
