Search
K
MarketConnect-OrderEntry

FieldGroupBlueprint

object
* Additional properties are NOT allowed.
idstringrequired

The unique identifier for the field group

>= 1 characters

partNamestringrequired

An identifier (partName) for the field group

>= 1 characters

textobject

The text associated with a field group, such as descriptions or related notes. Supports localization through language codes (e.g., en, fr).

* Additional properties are NOT allowed.
Show Child Parameters
titleobject

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

* Additional properties are NOT allowed.
Show Child Parameters
isCustomboolean

Indicates whether this is a custom field group

fieldsarray[object]

Array of fields (questions) within this field group

* Additional properties are NOT allowed.
Show Child Parameters
displayAsCardboolean

Indicates if this field group should be displayed as a card

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.

Example

FieldValidationRule

object
* Additional properties are NOT allowed.
messageobjectrequired

Localized message displayed to the user when validation fails

* Additional properties are NOT allowed.
Show Child Parameters
conditionsobjectrequired

The validation conditions wrapper containing an optional booleanOperator and an array of individual conditions

Example

LayoutSettings

object
* Additional properties are NOT allowed.
sizeinteger(int32)

The size of the field in a 12-column HTML grid that determines its rendered width (12 = full-width, 6 = half-width, 4 = one-third, 3 = quarter-width). Field column widths sum to 12 per row - e.g., two fields of 6 sit side-by-side, three fields of 4 share a row, four fields of 3 share a row.

Example

LocalizedText

object
* Additional properties are NOT allowed.
enstring

English text content

Example

QuestionData

object

Represents data for a single question in the transaction

* Additional properties are NOT allowed.
idstringrequired

The unique identifier for the question

>= 1 characters

typestringrequired

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

questionTextstring

The title of the question shown to the user. This value should be kept in sync with the title property of the associated field

questionSubTextstring

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

displayValuestring

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’

valueAny Of

The 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.

Variant 1string

String value for simple fields

Example:PrimaryBeneficiary

Example