Search
K
MarketConnect-OrderEntry

Blueprint

object
* Additional properties are NOT allowed.
sectionBlueprintsarray[object]required

An array of sections representing the hierarchical structure of an order entry blueprint, nested from sections to subsections, field groups, and individual fields

* Additional properties are NOT allowed.
Show Child Parameters
sectionGroupBlueprintsobjectrequired

Map of section groups keyed by group identifier. Each value assigns sections to their corresponding group.

Example

CreateTransactionRequest

object
* Additional properties are NOT allowed.
statestringrequired

The state in which the life or annuity transaction is being solicited.

>= 1 characters

cusipstringrequired

The unique identifier for the product. This code allows the Order Entry API to determine the appropriate distributor, carrier, and product configuration

>= 1 characters

Example

DatasetResponse

object
* Additional properties are NOT allowed.
Statusstringrequired

Outcome of the dataset lookup. “Success” on success; otherwise the backend exception type name (e.g. “NullReferenceException”, “ItemNotFoundException`2”).

>= 1 characters

Messagestringrequired

Human-readable message describing the outcome. On success a confirmation string; on failure the backend error message.

>= 1 characters

Datastring

Dataset payload serialized as a JSON string. On success, a JSON array of {Name, Value} option objects. On failure, may be “[]” or omitted.

InstanceIdinteger(int64)

Identifier of the dataset instance returned by the upstream service. Present for success and most failures; absent for low-level exceptions.

Example

DocumentRule

object
* Additional properties are NOT allowed.
conditionsstring

Conditions under which the rule applies

keystring

Rule key

messagestring

Rule message shown to the user

valuestring

Rule value

Example

ErrorInfo

object
* Additional properties are NOT allowed.
codestringrequired

Backend error codes returned by the Order Entry API indicating validation failures, transaction issues, blueprint generation errors, authorization errors, or unexpected system failures.

Allowed values:VALIDATION_ERRORINVALID_TRANSACTION_IDINVALID_STEP_NAMETRANSACTION_CREATION_FAILEDTRANSACTION_ID_NOT_FOUNDSAVE_TRANSACTION_ERRORSAVE_TRANSACTION_FAILEDINVALID_RESPONSE_FORMATBUILD_BLUEPRINT_ERRORJSON_PARSE_ERRORTRANSFORMER_NULL_RESPONSEEMPTY_BLUEPRINTUNEXPECTED_ERRORSERVICE_ERRORUNAUTHORIZEDFORBIDDENNOT_FOUNDFIRST_STEP_SETUP_FAILED

descriptionstring
detailsstring
timestampstring(date-time)required
Example