SchemasArtifactsForm
FormSignatureLast updated on
Last updated on
Signature requirements for a party role
FormSignature states whether a party role must sign a form, and how many witnesses or a notary that signature needs. It is set on a FormParty through its signature property.
Signing a form touches three schemas:
| Schema | Where | What it holds |
|---|---|---|
| FormSignature | parties.<role>.signature | Whether the role signs, and witness and notary rules |
| SignatureSlot | layers.<key>.signatures | Where each signing field sits on a layer |
| Signature | Runtime data | The captured signature: image, timestamp, and method |
Properties
required?: boolean
Whether a signature is required for this role. Defaults to false
witnesses?: number
Number of witnesses required for this signature. Minimum 0, defaults to 0
notarized?: boolean
Whether at least one witness must be a notary. Defaults to false
Example
A tenant must sign with one witness, and each signature has a slot on the PDF layer:
parties:
tenant:
label: Tenant
partyType: person
signature:
required: true
witnesses: 1
layers:
pdf:
kind: file
mimeType: application/pdf
path: lease.pdf
signatures:
tenant-sign:
party:
role: tenant
type: signature
placement:
anchor:
text: Tenant signature
offsetY: 12
width: 180
height: 36