Search
K
MarketConnect-OrderEntry

RenderCondition

object

Single condition controlling whether a field/section is rendered.

typestringrequired

Kind of comparison performed by the condition.

Allowed values:equalityrangepresence

Example:equality

isEqualboolean

When true the condition passes if the target value equals ‘value’; when false the condition passes if it differs.

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

RequiredDocument

object
* Additional properties are NOT allowed.
attachmentTypestring

Attachment type code

displayNamestring

Display name shown to the user

documentTypestring

Document type code

formTypestring

Form type code

messagestring

Instructional message for the required document

Example

SectionBlueprint

object
* Additional properties are NOT allowed.
idstringrequired

The unique identifier for the section

>= 1 characters

sectionGroupKeystring

A key used to group related sections within the blueprint

partNamestringrequired

An identifier (partName) for the section

>= 1 characters

titleobjectrequired

The section title in multiple languages. Supports localization through language codes (e.g., en, fr)

* Additional properties are NOT allowed.
Show Child Parameters
modulesarray[string]

An array of module names associated with this section

isCustomboolean

Indicates whether this section is custom

subsectionsarray[object]

Array of subsections within this section

* Additional properties are NOT allowed.
Show Child Parameters
copyablestring

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.

renderOnarray[string]

An array of conditions that determine when a section is rendered

pdfDocumentsarray[string]

An array of PDF document identifiers where this section appears

platformsarray[string]

An array of platforms where this section is available (e.g., D2C-only versus advisor-driven experiences)

visibleobject

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"}]}

* Additional properties are NOT allowed.
Show Child Parameters
Example

SectionGroupBlueprint

object
* Additional properties are NOT allowed.
idstringrequired

The unique identifier for the section group

>= 1 characters

titleobjectrequired

The section group title in multiple languages. Supports localization through language codes (e.g., en, fr)

* Additional properties are NOT allowed.
Show Child Parameters
partNamestring

An identifier (partName) for the section group

Example

SelectOption

object
* Additional properties are NOT allowed.
textobjectrequired

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’

* Additional properties are NOT allowed.
Show Child Parameters
valuestringrequired

The value 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’

>= 1 characters

Example