Search
K
MarketConnect-OrderEntry

Submit an order entry transaction for processing.

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - Request body is not allowed (endpoint does not accept a body, including empty {}).

  • INVALID_TRANSACTION_ID - The supplied transaction ID is invalid.

  • VALIDATION_ERROR - The upstream order entry service rejected the submission due to validation failures.

  • 401 Unauthorized

  • UNAUTHORIZED - Authentication failed or the access token is missing, expired, or invalid.

  • 403 Forbidden

  • FORBIDDEN - The authenticated user is not authorized to submit this transaction.

  • 404 Not Found

  • TRANSACTION_ID_NOT_FOUND - No transaction exists for the specified transaction ID.

  • 429 Too Many Requests

  • RATE_LIMIT_EXCEEDED - The client has exceeded the permitted request rate or quota.

  • 500 Internal Server Error

  • UNEXPECTED_ERROR - An unexpected internal system error occurred while submitting the transaction.

  • 502 Bad Gateway

  • UPSTREAM_SERVICE_ERROR - The upstream product service returned an error while processing the submit request.

  • 503 Service Unavailable

  • SERVICE_UNAVAILABLE - The service or a required dependency is temporarily unavailable.

  • 504 Gateway Timeout

  • UPSTREAM_TIMEOUT - A required downstream service did not respond within the configured timeout.

Standard Error Response

All error responses conform to the standard ErrorResponse schema and include:

  • A stable error code from ErrorInfo.code.
  • A human-readable error message.
  • Optional diagnostic details, when applicable.
  • A timestamp indicating when the error occurred.
    This consistent format enables clients to implement standardized error processing, logging, and troubleshooting across all Order Entry API endpoints.
post

Path Parameters

transactionIdstringrequired

The unique identifier for the transaction

Response

application/json

Transaction submitted successfully

SubmitTransactionResponse

* Additional properties are NOT allowed.
transactionIdstringrequired

The unique identifier for the submitted transaction. Echoed back from the request.

>= 1 characters

messagestringrequired

Human-readable confirmation that the submit request was accepted.

>= 1 characters

post/market-connect/order-entry/v1/transaction/{transactionId}/submit
 
application/json

Dataset

Dataset operations

Gets dataset values for a dependent control based on the provided payload.

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request failed input validation.

  • 401 Unauthorized

  • UNAUTHORIZED - Authentication failed or the access token is missing, expired, or invalid.

  • 403 Forbidden

  • FORBIDDEN - The authenticated user is not authorized to access this resource.

  • 429 Too Many Requests

  • RATE_LIMIT_EXCEEDED - The client has exceeded the permitted request rate or quota.

  • 500 Internal Server Error

  • UNEXPECTED_ERROR - An unexpected internal system error occurred while processing the request.

  • 502 Bad Gateway

  • UPSTREAM_SERVICE_ERROR - An upstream dependency returned an invalid or unsuccessful response.

  • 503 Service Unavailable

  • SERVICE_UNAVAILABLE - The service or a required dependency is temporarily unavailable.

  • 504 Gateway Timeout

  • UPSTREAM_TIMEOUT - A required downstream service did not respond within the configured timeout.

Standard Error Response

All error responses conform to the standard ErrorResponse schema and include:

  • A stable error code from ErrorInfo.code.
  • A human-readable error message.
  • Optional diagnostic details, when applicable.
  • A timestamp indicating when the error occurred.
    This consistent format enables clients to implement standardized error processing, logging, and troubleshooting across all Order Entry API endpoints.
post

Body

application/json

DatasetRequest

transactionIdstringrequired

Unique identifier of the transaction (positive integer as a string).

>= 1 characters

stepNamestringrequired

Name of the wizard step containing the dependent control.

>= 1 characters

fieldIdstringrequired

Identifier of the field (control) whose dataset is being requested.

>= 1 characters

Response

application/json

Returns the dataset payload

DatasetResponse

* 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 | null

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

InstanceIdinteger | null(int64)

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

post/market-connect/order-entry/v1/dataset

Body

{ "transactionId": "1064187", "stepName": "CarrierProductSelection", "fieldId": "504436", "Transaction.Parameters[\"CarrierID\"].Value": "CARRIER-001", "Transaction.SolicitationState": "Alabama" }
 
application/json

Attachment

Attachment operations for transaction documents.

Retrieves the attachment payload (documents, required documents and rules) for a transaction.

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request failed input validation.

  • 401 Unauthorized

  • UNAUTHORIZED - Authentication failed or the access token is missing, expired, or invalid.

  • 403 Forbidden

  • FORBIDDEN - The authenticated user is not authorized to access this resource.

  • 404 Not Found

  • NOT_FOUND - No attachments were found for the specified transaction.

  • 429 Too Many Requests

  • RATE_LIMIT_EXCEEDED - The client has exceeded the permitted request rate or quota.

  • 500 Internal Server Error

  • UNEXPECTED_ERROR - An unexpected internal system error occurred while processing the request.

  • 502 Bad Gateway

  • UPSTREAM_SERVICE_ERROR - An upstream dependency returned an invalid or unsuccessful response.

  • 503 Service Unavailable

  • SERVICE_UNAVAILABLE - The service or a required dependency is temporarily unavailable.

  • 504 Gateway Timeout

  • UPSTREAM_TIMEOUT - A required downstream service did not respond within the configured timeout.

Standard Error Response

All error responses conform to the standard ErrorResponse schema and include:

  • A stable error code from ErrorInfo.code.
  • A human-readable error message.
  • Optional diagnostic details, when applicable.
  • A timestamp indicating when the error occurred.
    This consistent format enables clients to implement standardized error processing, logging, and troubleshooting across all Order Entry API endpoints.
get

Path Parameters

transactionIdstringrequired

Unique identifier assigned when the Order Entry transaction is created. Resolves to the internal transaction; caller must be authorized for this transaction.

Example:1125715

Response

application/json

Returns the attachment payload

AttachmentResponse

* Additional properties are NOT allowed.
transactionIdstringrequired

Unique identifier for the Order Entry transaction.

>= 1 characters

carrierCodestringrequired

Carrier code required to push documents to EDS.

>= 1 characters

distributorCodestring | null

Optional distributor code.

sourceSystemstring | null

Source system identifier. Allowed values: AnnuityNet, LifeSpeed.

Allowed values:AnnuityNetLifeSpeed

caseIdstring | null

Case identifier associated with the transaction.

dataobjectrequired

Documents already uploaded, required documents, optional types, and document rules.

Example:{"additionalDocumentTypes":[{"attachmentType":[],"documentType":["Wet-signed Paperwork","Supporting Documents","Trust Certification","Green Card","Driver License – Proof of Age","Illustration","POA Paperwork","Check Deposit Form"],"formType":[]}],"documentRules":[{"conditions":"Owner age < 65","key":"PROOF_OF_AGE","message":"Proof of age documentation may be required.","value":"optional"}],"documents":[{"documentType":"ESIGNATURE","fileName":"NAICBuyerGuideFixedDeferredAnnuitiesMTNM.pdf","uploadDate":"04/06/2026 11:22:05 PM","documentId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","documentSize":9000000,"attachmentType":null,"formType":null},{"documentType":"DRIVER LICENSE – PROOF OF AGE","fileName":"NAICBuyerGuideFixedDeferredAnnuitiesMTNM1.pdf","uploadDate":"04/06/2026 11:26:07 PM","documentId":"b2c3d4e5-f6a7-8901-bcde-f12345678901","documentSize":10000000,"attachmentType":null,"formType":null}],"requiredDocuments":[{"attachmentType":"APP","displayName":"Signed application","documentType":"APPLICATION","formType":"APP_FULL","message":"Upload the fully signed application prior to submission."}]}

* Additional properties are NOT allowed.
Show Child Parameters
get/market-connect/order-entry/v1/attachment/{transactionId}
 
application/json