ValidationCondition

object

Single validation condition inside a FieldValidationRule. The shape varies by type: matchesRegexCondition uses regex; numberComparisonCondition uses value + operator; characterCountInBetween uses value: { minLength, maxLength }.

typestringrequired

The kind of validation this condition performs.

Allowed values:matchesRegexConditionnumberComparisonConditioncharacterCountInBetween

Example:matchesRegexCondition

targetNodeIdstringrequired

The answer node identifier this condition evaluates.

Example:Transaction.Beneficiaries[0].EmailAddresses["Home"].Address

regexstring

Regex pattern. Only used when type is matchesRegexCondition.

Example:^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

operatorstring

Comparison operator. Only used when type is numberComparisonCondition.

Allowed values:lessThanlessThanOrEqualgreaterThangreaterThanOrEqualequalnotEqual

Example:lessThanOrEqual

valueAny Of

Condition-specific value. Number for numberComparisonCondition; object { minLength, maxLength } for characterCountInBetween. Absent for matchesRegexCondition.

Variant 1number

Example:9999999999

Example

ValidationConditionGroup

object
* Additional properties are NOT allowed.
booleanOperatorstring

The boolean operator used to combine multiple conditions (e.g., “and”). Omitted when there is only one condition.

conditionsarray[object]

Single validation condition inside a FieldValidationRule. The shape varies by type: matchesRegexCondition uses regex; numberComparisonCondition uses value + operator; characterCountInBetween uses value: { minLength, maxLength }.

Show Child Parameters
Example

ValidationErrors

object

One validation message in API shape. Optional properties are omitted in JSON when null (e.g. fieldId is missing or 0).

* Additional properties are NOT allowed.
fieldIdstring

ControlID as a string (numeric ids appear quoted). Omitted when fieldId is 0.

answerNodeIdstring

Answer node path from annuity NamedItem; matches FieldBlueprint.AnswerNodeId.

messagestring

The validation error message

sectionNamestring

The section/step name where the error occurred

indexinteger(int32)

Row index for a repeatable/collection field the error applies to; omitted for non-repeatable fields.

Example

VisibilityCondition

Single condition or nested condition group controlling visibility or optionality at runtime.

One Of
typestringrequired

Kind of comparison performed by the condition.

Allowed values:equalityequalityConditionrangepresence

Example:equalityCondition

isEqualboolean

When true the target must equal value; when false it must differ.

Example:true

valuestring

The value to compare against the resolved target answer.

Example:NY

targetNodeIdstringrequired

The answer node identifier whose value is evaluated by this condition.

Example:SolicitationStateCode

Example

VisibilitySettings

object
* Additional properties are NOT allowed.
booleanOperatorstring

The boolean operator for combining conditions

conditionsOne Of
array

Single condition or nested condition group controlling visibility or optionality at runtime.

Variant 1object
Show Child Parameters
Example