ValidationCondition
objectSingle validation condition inside a FieldValidationRule. The shape varies by type: matchesRegexCondition uses regex; numberComparisonCondition uses value + operator; characterCountInBetween uses value: { minLength, maxLength }.
The kind of validation this condition performs.
Allowed values:matchesRegexConditionnumberComparisonConditioncharacterCountInBetween
Example:matchesRegexCondition
The answer node identifier this condition evaluates.
Example:Transaction.Beneficiaries[0].EmailAddresses["Home"].Address
Regex pattern. Only used when type is matchesRegexCondition.
Example:^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
Comparison operator. Only used when type is numberComparisonCondition.
Allowed values:lessThanlessThanOrEqualgreaterThangreaterThanOrEqualequalnotEqual
Example:lessThan
Any OfCondition-specific value. Number for numberComparisonCondition; object { minLength, maxLength } for characterCountInBetween. Absent for matchesRegexCondition.
Example:9999999999
ValidationConditionGroup
objectThe boolean operator used to combine multiple conditions (e.g., “and”). Omitted when there is only one condition.
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
ValidationErrors
objectOne validation message in API shape. Optional properties are omitted in JSON when null (e.g. fieldId is missing or 0).
ControlID as a string (numeric ids appear quoted). Omitted when fieldId is 0.
Answer node path from annuity NamedItem; matches FieldBlueprint.AnswerNodeId.
The validation error message
The section/step name where the error occurred
VisibilityCondition
objectSingle condition controlling whether a field/section is visible at runtime.
Kind of comparison performed by the condition.
Allowed values:equalityrangepresence
Example:equality
When true the condition passes if the target value equals ‘value’; when false the condition passes if it differs.
Example:true
The value to compare against the resolved target answer.
Example:NY
The answer node identifier whose value is evaluated by this condition.
Example:SolicitationStateCode
VisibilitySettings
objectThe boolean operator for combining conditions
Single condition controlling whether a field/section is visible at runtime.