Undersign
v1.1
Create Free Account
API Reference Core concepts · Signers
Core concepts

Signers

Signers are the recipients participating in a signing workflow. Each signer is defined by a name and an email address.

The signer model

The supplied signer model is a simple object:

JSON
{
  "name": "John Doe",
  "email": "john@example.com"
}

Both name and email are required.

Signer roles in templates

Templates define signer roles that describe who signs and which fields are assigned to them. Template details include a signers_with_fields array where each role can contain an id, name, initials and its assigned fields. When creating a signature request you provide the actual signer names and emails for those roles.

Signer status

When you retrieve signature request status, each signer appears with signer_name, signer_email, signer_status, a signing_link and the documents assigned to them. Use this to see who has signed and who is still pending.