What are Fields in the Yousign API?

Fields in the Yousign API are dynamic elements placed on a Document to capture the Signer's inputs or display dynamic content.

Each field is associated with a Signer and a Document, ensuring the right information appears in the correct location.

How do fields work?

Fields are added during the Signature Request creation process. There are two ways to add a field to a Signature Request:

Smart Anchors allow you to embed predefined text patterns directly into your document using a word processor (Word, GDocs, etc.). Yousign detects these patterns and replaces them with the corresponding fields.
Manual Field creation enables you to place Fields (such as Signature, Text, and Checkboxes) by specifying their exact position via a dedicated endpoint.

Combining both methods

Fields created using Smart Anchors can later be modified or repositioned via the API, offering greater flexibility in Document preparation.

Available Fields types

Below is a summary of all available Field types and their purpose. Each Field serves a specific function in the signing flow, helping you to refine the Document creation and Signer experience. Please refer to the dedicated guides to learn more about them.

Type	Purpose
Signature	Most common Field Type. It captures a Signer's signature.
Mention	Mention Field allows you to display a mention in a Document while avoiding manual input for the Signer.
Text	Let the Signer enter text based on a set of instructions (e.g., name, address, custom input).
Read-Only Text	Displays non-editable information on the document.
Initial	Will automatically place a Signer’s initials on all pages of a document.
Checkbox	Let signers select an option (e.g., agreement confirmation).
Radio Button	Enables Signers to choose one option from a predefined set.