TemplateAnnotationApiResponse

Properties

Name Type Description Notes
id UUID The unique annotation identifier. [default to null]
documentId UUID The document this annotation is placed on. [default to null]
roleName String The name of the role assigned to this annotation. [default to null]
type String The annotation type (e.g., "Signature", "Initials", "DateSigned", "Text", "Checkbox"). [default to null]
label String An optional display label shown to the signer (e.g., "Sign here", "Enter your title"). [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. [default to null]
y Double The Y coordinate of the annotation's top-left corner in PDF points. 0 = top edge of page. [default to null]
width Double The width of the annotation in PDF points. [default to null]
height Double The height of the annotation in PDF points. [default to null]
required Boolean Whether the signer is required to complete this annotation before finishing. [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 0]

[Back to Model list] [Back to API list] [Back to README]