LocalizedText
objectEnglish text content
QuestionData
objectRepresents data for a single question in the transaction
The unique identifier for the question
>= 1 characters
The data-storage type of the question. Canonical values: input, dropdown, radio, checkbox, checkboxgroup, date, phone, email, money, number, label, information, collection, Person, Address, Hidden. FieldBlueprint.fieldType covers rendering types; QuestionData.type additionally supports ‘collection’ for nested repeatable groups.
>= 1 characters
The title of the question shown to the user. This value should be kept in sync with the title property of the associated field
The subtext shown to the user below the question title. This value should be kept in sync with the text property of the associated field
The display text representing the user’s selected answer. For example, a country dropdown may display ‘United States of America’ to the user, while the blueprint stores the value as ‘USA’
Any OfThe actual value of the question. Can be a string, integer, number, float, date, date-time, boolean, or array of CollectionItem objects depending on the field type.
String value for simple fields
Example:PrimaryBeneficiary
RenderCondition
objectSingle condition controlling whether a field/section is rendered.
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
RequiredDocument
objectAttachment type code
Display name shown to the user
Document type code
Form type code
Instructional message for the required document
SectionBlueprint
objectThe unique identifier for the section
>= 1 characters
A key used to group related sections within the blueprint
An identifier (partName) for the section
>= 1 characters
The section title in multiple languages. Supports localization through language codes (e.g., en, fr)
Show Child Parameters
An array of module names associated with this section
Indicates whether this section is custom
Array of subsections within this section
Show Child Parameters
Role identifier controlling copy behavior. Use ‘none’ to disable copying, or a role name (e.g., ‘owner’, ‘annuitant’, ‘insured’, ‘payor’). Multiple roles may be comma-separated.
An array of conditions that determine when a section is rendered
An array of PDF document identifiers where this section appears
An array of platforms where this section is available (e.g., D2C-only versus advisor-driven experiences)
Visibility conditions for the section. When present, the section is only visible when all conditions are met. Example: { “booleanOperator”: “AND”, “conditions”: [ { “type”: “equality”, “isEqual”: true, “value”: “NY”, “targetNodeId”: “SolicitationStateCode” } ] }
Example:{"booleanOperator":"AND","conditions":[{"type":"equality","isEqual":true,"value":"Yes","targetNodeId":"Transaction.SolicitationState"},{"type":"equality","isEqual":true,"value":"Yes","targetNodeId":"Transaction.SolicitationState"}]}