Signature fields are placed on documents within an envelope to define where and how each recipient must interact with the document. This page covers all available field types, placement properties, styling options, and recipient roles.
| Type | Description |
|---|---|
signature | A standard signature field — the recipient can sign by typing, drawing, uploading, or using a pre-saved signature |
digitalsignature | A certificate-backed digital signature field — requires a PKI certificate via NexU |
initial | An initials field — the recipient provides their initials rather than a full signature |
text | A freeform text input field |
name | A name field — pre-populated with the recipient's name if available |
email | An email field — pre-populated with the recipient's email address if available |
company | A company name field |
title | A job title field |
number | A numeric input field |
date | A date field — pre-populated with the signing date if available |
note | A read-only annotation field visible to the recipient during signing |
checkbox | A checkbox the recipient must check or uncheck |
radio | A radio button — use multiple radio fields with the same group name for single-select options |
stamp | A stamp field — the recipient applies a stamp image |
drawing | A freehand drawing field |
Every field requires the following placement properties:
| Property | Type | Description |
|---|---|---|
referenceDocumentId | integer | References the document within the envelope this field is placed on |
referenceSignerId | integer | References the recipient assigned to complete this field |
referenceSignGroupId | integer | References a recipient group instead of an individual recipient — used when the envelope defines signGroups. Any signer within the group can complete the field |
page | integer | The page number the field appears on |
positionX | number | Horizontal position of the field on the page |
positionY | number | Vertical position of the field on the page |
width | number | Width of the field |
height | number | Height of the field |
name | string | A unique identifier for the field within the envelope |
isRequired | boolean | Whether the recipient must complete this field before submitting |
The optional properties object controls how the completed value is rendered in the document:
| Property | Type | Description |
|---|---|---|
fontFamily | string | Font used to render the field value — e.g. Arial, Times New Roman |
fontSize | integer | Font size in points |
color | string | Font colour — accepts named colours (e.g. red) or hex values (e.g. #CC0000) |
bold | boolean | Renders the value in bold |
italic | boolean | Renders the value in italic |
underline | boolean | Renders the value with underline |
textAlign | string | Horizontal alignment — left, center, or right |
Example field definition:
{
"type": "signature",
"isRequired": true,
"referenceSignerId": 1,
"referenceDocumentId": 1,
"page": 1,
"positionX": 10,
"positionY": 10,
"width": 200,
"height": 60,
"name": "buyer_signature",
"properties": {
"fontFamily": "Arial",
"fontSize": 13,
"color": "#333333",
"textAlign": "center"
}
}The role field on a recipient determines what they can do in the signing session:
| Role | Description |
|---|---|
signer | Must complete all assigned fields before the envelope can proceed |
viewer | Views the document — cannot sign, can leave comments |
cc | Receives a copy of the completed envelope by email — no interaction required |