In a multi-blueprint setup, this endpoint allows navigation to a specific section within the blueprint structure and returns the blueprint for the selected section for rendering
400 Bad Request:
VALIDATION_ERROR - Input validation failed
INVALID_TRANSACTION_ID - Transaction ID is less than or equal to 0
INVALID_STEP_NAME - Step name is null or whitespace
401 Unauthorized:
UNAUTHORIZED - Authentication failed or token is invalid
403 Forbidden:
FORBIDDEN - User does not have permission to access this resource
404 Not Found:
TRANSACTION_ID_NOT_FOUND - Transaction not found in the system
NOT_FOUND - Transaction or step not found
500 Internal Server Error:
BUILD_BLUEPRINT_ERROR - Error building the blueprint
JSON_PARSE_ERROR - Error parsing JSON response
UNEXPECTED_ERROR - Unexpected system error
On success, returns a TransactionResponse with:
Unique identifier assigned when an order entry transaction is created
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.
Returns a product’s order entry blueprint with associated answer data
The unique identifier for the created transaction
>= 1 characters
The case identifier returned by the product service
Dictionary of question data keyed by question ID
The blueprint containing section and field definitions
Subscribers defining dataset dependency actions
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"}
Collection of validation errors when transaction validation fails. Includes transaction ID, field ID, and error messages.
Example:{"answerNodeId":"Transaction.PrimaryOwner.FirstName","message":"First name is required","sectionName":"PersonalInformation"}
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 is a JSON object where:
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 "259726": {
"id": "259726",
"type": "dropdown",
"questionText": "Account designation",
"questionSubText": "Account designation",
"displayValue": "Owner",
"value": "Owner"
}
}```
"489363": {
"id": "489363",
"type": "collection",
"questionText": "Name",
"questionSubText": "",
"displayValue": "",
"value": [
{
"surrogateId": "489363_1",
"type": "collectionItem",
"data": {
"489363_FirstName": {
"id": "489363_FirstName",
"type": "input",
"questionText": "First Name",
"questionSubText": "",
"displayValue": "John",
"value": "John"
},
"489363_LastName": {
"id": "489363_LastName",
"type": "input",
"questionText": "Last Name",
"questionSubText": "",
"displayValue": "Doe",
"value": "Doe"
}
}
}
]
}
}```
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 (dictionary of question data)
Transaction update request - a dictionary keyed by question ID whose values are QuestionData objects.
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 of question data keyed by question ID
The blueprint containing section and field definitions
Subscribers defining dataset dependency actions
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"}
Collection of validation errors when transaction validation fails. Includes transaction ID, field ID, and error messages.
Example:{"answerNodeId":"Transaction.PrimaryOwner.FirstName","message":"First name is required","sectionName":"PersonalInformation"}
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 of question data keyed by question ID
The blueprint containing section and field definitions
Subscribers defining dataset dependency actions
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"}
Collection of validation errors when transaction validation fails. Includes transaction ID, field ID, and error messages.
Example:{"answerNodeId":"Transaction.PrimaryOwner.FirstName","message":"First name is required","sectionName":"PersonalInformation"}
Accepts a transaction for submission and processes it asynchronously. Returns immediately without waiting for the backend service to complete.
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