What is a Read-Only Text Field?

A Read-Only Text Field allow you to add static content to a Document. It is useful for inserting after the Document upload: legal disclaimers, instructions, reference numbers, or any predefined text that must remain unchanged.

A Read-Only Text Field is visible to all signers and cannot be modified, serving solely as an informational element within the Document.

Read-Only Text Field creation

Before jumping to the creation options, let’s review the main characteristics of a Read-Only Text Field:

Parameters	Descriptions
`width`	Width of the Read-Only Text Field. Optional. Constraints: • If not set, the width is automatically calculated with the read only text length. • 24px is the minimum width authorized
`height`	Height of the Read-Only Text Field. Optional. Constraints: • The default value is 24px • 1px is the minimum value authorized • The height must take into account the font size (10px) and the line height (1.5). To calculate the height, please use this formula: height = (nb of lines) font-size (10) line height (1.5)
`text`	Static text to display on the Document.
`font`	Define the font family, color, size, and style variant configuration. Optional.

Read-Only Text Field creation with API endpoints

To create a Read-Only Text Field use this endpoint:/POST /fields/{signatureRequestId}/documents/{documentId}/fields.

Customisation

Read-Only Text Field appearance

You can configure the font family, color, size, and style variant of a Read-Only Text Field. To do that, you have to fill in the font parameters when creating a Read-Only Text Field with the following values.

Parameter	Optional	Details
`family`	`true`	• String of font family name (valid values are available in the API Reference) • Default value is Inconsolata
`color`	`true`	• Hexa string of the desired color • Default value is `#000000`
`size`	`true`	• Integer value of the desired pixel size • Min size: 7px • Max size: 96px • Default values is 12px
`variants`	`true`	Object containing the following possible values: `"variants": { "italic": false, "bold": false }`

⚠️ If a font node is provided, then height and width properties become mandatory, and Field sizes will not be automatically calculated.