In a multi-blueprint setup, this endpoint is used to save user responses and return the next relevant blueprint for continued rendering
The request body matches the data node returned by GET and Create transaction APIs:
index for repeatable collection rows)input | Text input field | string | - dropdown | Select dropdown field | string | - radio | Radio button field | string | - checkbox | Checkbox field | boolean | - date | Date picker field | string (YYYY-MM-DD) | - phone | Phone number field | string | - collection | Complex nested data structure | array of CollectionItem | #### Simple Field Example "data": {
"259726": [{
"id": "259726",
"type": "dropdown",
"questionText": "Account designation",
"questionSubText": "Account designation",
"displayValue": "Owner",
"value": "Owner",
"index": 0
}]
}
}```
"data": {
"489363_FirstName": [{
"id": "489363_FirstName",
"type": "text",
"questionText": "First Name",
"displayValue": "John",
"value": "John",
"index": 0
}],
"489363_LastName": [{
"id": "489363_LastName",
"type": "text",
"questionText": "Last Name",
"displayValue": "Doe",
"value": "Doe",
"index": 0
}]
}
}```
400 Bad Request:
VALIDATION_ERROR - Input validation failed (ModelState errors)
INVALID_TRANSACTION_ID - Invalid transaction ID provided
INVALID_STEP_NAME - Invalid step name provided
401 Unauthorized:
UNAUTHORIZED - Authentication failed or token is invalid
403 Forbidden:
FORBIDDEN - User does not have permission to update this transaction
500 Internal Server Error:
SAVE_TRANSACTION_ERROR - Save operation failed at service level
SAVE_TRANSACTION_FAILED - Save operation not successful
INVALID_RESPONSE_FORMAT - Invalid response format from service
EMPTY_BLUEPRINT - Empty blueprint returned after save
BUILD_BLUEPRINT_ERROR - Error building blueprint for next step
UNEXPECTED_ERROR - Unexpected system error
On success, returns a TransactionResponse with:
This endpoint is used to:
The unique identifier for the transaction
PascalCase step identifier matching the section ID in the blueprint (e.g. CarrierProductSelection, EntityOwners). Values are returned verbatim from the backend blueprint - do not lowercase or transform them. Optional for enhanced blueprint.
The input data for updating the transaction (data object matching GET/Create response shape)
Transaction update request. The data property matches TransactionResponse.data (field id → array of QuestionData rows, with index for collection rows). A field value may also be a single QuestionData object when prefilled (see prefilled on QuestionData).
Dictionary keyed by question id or composite collection field id; values are arrays of QuestionData (includes index for collection rows).
Returns the Order Entry blueprint for next step or success status
The unique identifier for the created transaction
>= 1 characters
The case identifier returned by the product service
Dictionary keyed by question id or composite collection field id; values are arrays of QuestionData (includes index for collection rows).
The blueprint containing section and field definitions
Reactive subscriber definitions consumed by the UI. Each subscriber declares trigger fields, an HTTP action to run on change, and a response handler. Two flavors are emitted: dataset-dependency (context-modification) and blueprint-modification (replace-whole).
Example:{"triggers":["FirstName"],"actions":[{"type":"http","verb":"get","url":"/market-connect/order-entry/v1/transaction/1125715/MCDPS","token":"OEToken","payload":{"type":"none"},"responseHandlers":[{"type":"blueprint-modification","action":"replace-whole","value":{"type":"response-query","kind":"json-path","value":"$.data"}}]}]}
Collection of errors if the operation failed
Example:{"code":"VALIDATION_ERROR","description":"Input validation failed","details":"One or more input fields are invalid","timestamp":"2024-01-15T10:30:00.000Z"}
One validation message in API shape. Optional properties are omitted in JSON when null (e.g. fieldId is missing or 0).
Example:{"fieldId":"BeneficiaryAddress","answerNodeId":"Transaction.PrimaryOwner.PersonName.Prefix","message":"First name is required","sectionName":"EntityOwners"}
400 Bad Request:
VALIDATION_ERROR - Input validation failed (ModelState errors)
INVALID - Invalid input parameters
401 Unauthorized:
UNAUTHORIZED - Authentication failed or token is invalid
403 Forbidden:
FORBIDDEN - User does not have permission to create transactions
500 Internal Server Error:
TRANSACTION_CREATION_FAILED - Transaction creation failed at service level
TRANSACTION_ID_NOT_FOUND - Service didn’t return transaction ID
FIRST_STEP_SETUP_FAILED - First step initialization failed (breadcrumb, payload creation, or save)
JSON_PARSE_ERROR - Failed to parse service response
BUILD_BLUEPRINT_ERROR - Error building blueprint after creation
UNEXPECTED_ERROR - Unexpected system error
On success, returns a TransactionResponse with:
The following fields are validated:
The API automatically routes to the appropriate service based on CUSIP:
The transaction creation process includes:
The FIRST_STEP_SETUP_FAILED error can occur when:
The input data for creating a new transaction
The state in which the life or annuity transaction is being solicited.
>= 1 characters
The unique identifier for the product. This code allows the Order Entry API to determine the appropriate distributor, carrier, and product configuration
>= 1 characters
Returns the Order Entry blueprint for the created transaction
The unique identifier for the created transaction
>= 1 characters
The case identifier returned by the product service
Dictionary keyed by question id or composite collection field id; values are arrays of QuestionData (includes index for collection rows).
The blueprint containing section and field definitions
Reactive subscriber definitions consumed by the UI. Each subscriber declares trigger fields, an HTTP action to run on change, and a response handler. Two flavors are emitted: dataset-dependency (context-modification) and blueprint-modification (replace-whole).
Example:{"triggers":["FirstName"],"actions":[{"type":"http","verb":"get","url":"/market-connect/order-entry/v1/transaction/1125715/MCDPS","token":"OEToken","payload":{"type":"none"},"responseHandlers":[{"type":"blueprint-modification","action":"replace-whole","value":{"type":"response-query","kind":"json-path","value":"$.data"}}]}]}
Collection of errors if the operation failed
Example:{"code":"VALIDATION_ERROR","description":"Input validation failed","details":"One or more input fields are invalid","timestamp":"2024-01-15T10:30:00.000Z"}
One validation message in API shape. Optional properties are omitted in JSON when null (e.g. fieldId is missing or 0).
Example:{"fieldId":"BeneficiaryAddress","answerNodeId":"Transaction.PrimaryOwner.PersonName.Prefix","message":"First name is required","sectionName":"EntityOwners"}
Submits the transaction to the annuity order-entry service. Returns 400 with the inner Data.Message when Data.Success is false and TotalValidationErrors is greater than zero.
The unique identifier for the transaction
OK
The unique identifier for the submitted transaction. Echoed back from the request.
>= 1 characters
Human-readable confirmation that the submit request was accepted.
>= 1 characters
Dataset operations
Returns dataset contents based on the provided transaction, step, field, and dependency inputs.
Unique identifier of the transaction (positive integer as a string).
>= 1 characters
Name of the wizard step containing the dependent control.
>= 1 characters
Identifier of the field (control) whose dataset is being requested.
>= 1 characters
Returns the dataset payload
Outcome of the dataset lookup. “Success” on success; otherwise the backend exception type name (e.g. “NullReferenceException”, “ItemNotFoundException`2”).
>= 1 characters
Human-readable message describing the outcome. On success a confirmation string; on failure the backend error message.
>= 1 characters
Dataset payload serialized as a JSON string. On success, a JSON array of {Name, Value} option objects. On failure, may be “[]” or omitted.
Identifier of the dataset instance returned by the upstream service. Present for success and most failures; absent for low-level exceptions.