Signer Name
What is a Signer Name Field?
A Signer Name Field automatically displays the Signer's name on the signed document. It is read-only for Signers and filled in automatically based on their profile information.
The Field value is populated from the Signer's first_name and last_name properties. If the Signer's information changes before signing, the Field updates accordingly. The final value is locked when the Signer signs the document.
You can customize the name format (full name, first name only, or last name only) and configure the font appearance.
Signer Name Field creation
Before jumping to the creation options, let's review the main characteristics of a Signer Name Field:
| Parameter | Description |
|---|---|
format | Format used to display the name: full_name (default), first_name, or last_name |
font | Define the font family, color, size, and style variant configuration |
Signer Name Field creation with Smart Anchors
Smart Anchors allow you to insert a Signer Name Field within your document using this pattern:
- Pattern:
{{signer_index|signer_name|format|name}}
format: optional string indicating how the name is displayed.
full_name(default): displays "John Doe"first_name: displays "John"last_name: displays "Doe"name: optional custom label for the Field.
Optional parameters:
formatandnameare optional, but their|separators are always required, even if empty.
- Examples:
{{s1|signer_name||}},{{s1|signer_name|full_name|Name1}},{{s2|signer_name|first_name|FirstName}}
The Signers index (s1, s2, s3, etc) is determined by the Signers order in the Signature Request. If the index references a non-existent Signer, the Field won't be created.
Signer Name Field creation with API endpoints
To create a Signer Name Field using the API endpoints:
- Add a Signer Name Field to an existing Signer using this endpoint:
/POST /signature_requests/{signatureRequestId}/documents/{documentId}/fields
Customisation
A Signer Name Field can be customised to fit your needs:
- Name format: choose among three formats:
full_name→John Doefirst_name→Johnlast_name→Doe
- Appearance: configure the font family, color, size, and style variants (same options as Text Fields).
Updated about 19 hours ago