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.
  • Field creation with API endpoints enables you to place Fields (such as Signature, Text, and Checkboxes) by specifying their exact position via a dedicated endpoint.

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.

TypePurpose
SignatureMost common Field Type. It captures a Signer's signature.
MentionMention Field allows you to display a mention in a Document while avoiding manual input for the Signer.
InitialWill automatically place a Signer’s initials on all pages of a document.
TextLet the Signer enter text based on a set of instructions (e.g., name, address, custom input).
Read-Only TextDisplays non-editable information on the document.
CheckboxLet signers select an option (e.g., agreement confirmation).
Radio ButtonEnables Signers to choose one option from a predefined set.