Skip to main content

Create eSign transaction from templates

Creates an eSignature transaction using pre-configured templates. Participants are assigned to template roles, and documents are generated from the template with optional free-text field values. Requires the apiTemplatingEsign feature. Maximum 4 participants per transaction.

Request Body REQUIRED
templates object[] REQUIRED

List of templates to use for creating the eSign session

id uuid REQUIRED

The template ID

fields object[]

Free-text field values for document generation

id uuid REQUIRED

The free-text field ID from the template

text string REQUIRED

The text value to embed in the document

participants object[] REQUIRED

List of participants (max 4). Each must be assigned a role from the template.

email email REQUIRED

Participant's email address (must be unique)

firstName string REQUIRED

Participant's first name

lastName string REQUIRED

Participant's last name

middleName string

Participant's middle name

phone string

Phone number (required for SMS two-factor)

roleId uuid REQUIRED

The role ID from the template (must be unique per participant)

primary boolean

Exactly one participant must be primary

order integer

Signing order (0-based, sequential)

authenticationType string

Possible values: [none, personal-password, two-factor-authentication]

Authentication type

twoFactorContact string

Possible values: [email, sms]

Two-factor contact method

personalPasswordQuestion string

Security question for personal-password auth

personalPassword string

Security answer for personal-password auth

Responses
201

eSign transaction created from template successfully

Schema OPTIONAL
esignId uuid

The eSign session ID

transactionId uuid

The transaction ID

400

Validation error

Schema OPTIONAL
detail string OPTIONAL
error string OPTIONAL
message string OPTIONAL
help string OPTIONAL
401

Unauthorized — apiTemplatingEsign feature not enabled

Schema OPTIONAL
detail string OPTIONAL
error string OPTIONAL
message string OPTIONAL
help string OPTIONAL
404

Template not found

Schema OPTIONAL
detail string OPTIONAL
error string OPTIONAL
message string OPTIONAL
help string OPTIONAL