FormPartyLast updated on
Last updated on
Party role definitions for forms
FormParty defines what roles exist and what constraints apply when filling a form. Parties are the people or organizations that participate in a form, such as signers, witnesses, or other stakeholders.
Party data format is determined by the max property:
max = 1(default): single party object with requiredidmax > 1: array of party objects, each with requiredid
ID convention: {role}-{index} (e.g., "tenant-0", "landlord-1")
Properties
label: string
Human-readable role name
description?: string
Description of this role
partyType?: 'person' | 'organization' | 'any'
Constraint on party type
min?: number
Minimum parties required. Defaults to 1
max?: number
Maximum parties allowed. Defaults to 1. When max > 1, party data must be an array
required?: boolean | string
Whether this role is required. Can be boolean or expression
signature?: FormSignature
Signature requirements for this role
FormSignature
Signature requirements for a party role. Specifies whether a signature is required and optional witness/notarization requirements.
required?: boolean
Whether signature is required. Defaults to false
witnesses?: number
Number of witnesses required for this signature
notarized?: boolean
Whether at least one witness must be a notary
Examples
Single Party (Default)
When max is 1 (or omitted), the party data is a single object:
parties:
landlord:
label: Landlord
partyType: any
required: true
signature:
required: trueRuntime data for single party:
{
"parties": {
"landlord": {
"id": "landlord-0",
"legalName": "ABC Property LLC"
}
}
}Multiple Parties
When max > 1, the party data must be an array:
parties:
tenant:
label: Tenant
partyType: person
min: 1
max: 4
required: true
signature:
required: true
witnesses: 1Runtime data for multiple parties:
{
"parties": {
"tenant": [
{ "id": "tenant-0", "fullName": "Jane Smith" },
{ "id": "tenant-1", "fullName": "John Smith" }
]
}
}Related
- Form - Form artifact overview