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
Retrieves the attachment payload (documents, required documents and rules) for a transaction.
Returns documents, required documents, additional document types and document rules for the specified transaction.
get
Path Parameters
Response
application/json
Response
application/json
Returns the attachment payload
AttachmentResponse
* Additional properties are NOT allowed.
transactionIdstringrequired
Unique identifier for the Order Entry transaction.
>= 1 characters
caseIdstring | null
Case identifier associated with the transaction.
dataobjectrequired
Documents already uploaded, required documents, optional types, and document rules.
Example:{"additionalDocumentTypes":[{"attachmentType":["ID"],"documentType":["DRIVER LICENSE – PROOF OF AGE"],"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."}]}{"additionalDocumentTypes":[{"attachmentType":["ID"],"documentType":["DRIVER LICENSE – PROOF OF AGE"],"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}
Authentication
Path Parameters
application/json
Comments
Comment management operations (save, list, and delete transaction comments)
Saves a comment against the specified transaction.
Saves a comment for the specified transaction and returns the upstream envelope including validation messages.
post
Body
application/json
Body
application/json
The comment payload to save.
* Additional properties are NOT allowed.
appSubIndicatorstring | null
Indicator identifying whether the comment applies to the application or sub-application
commentSourcestring | null
Source system or user group that authored the comment
commentTextstringrequired
Free-form comment text
>= 1 characters
statusAtStepstring | null
Status code of the transaction at the step the comment was added
statusDisplayNamestring | null
Display name for the status at the step the comment was added
stepTitlestring | null
Title of the wizard step the comment was added on
transactionIdstringrequired
Unique identifier of the transaction the comment belongs to (positive integer encoded as a string)
Match pattern:^[1-9][0-9]*$
>= 1 characters
Response
application/json
Response
application/json
Returns the save comment envelope
SaveCommentResponse
* Additional properties are NOT allowed.
caseIdstring | null
Case identifier associated with the transaction. Populated on successful saves.
isSuccessboolean
Indicates whether the operation was successful
messagestring | null
Human-readable message describing the result
statusstring | null
Status code of the operation (e.g., “Success”, “ValidationError”, “Failure”)
post/market-connect/order-entry/v1/comments
Authentication
Body
{
"appSubIndicator": "App",
"commentSource": "OrderEntryUI",
"commentText": "Customer requested a follow-up call before submission.",
"statusAtStep": "InProgress",
"statusDisplayName": "In Progress",
"stepTitle": "Owner Information",
"transactionId": "1125715"
}
application/json
Deletes a comment from a transaction.
Deletes the specified comment from the transaction and returns the upstream envelope.
delete
Body
application/json
Body
application/json
The comment and transaction identifiers for the comment to delete.
* Additional properties are NOT allowed.
commentIdstringrequired
Unique identifier of the comment to delete (positive integer encoded as a string)
Match pattern:^[1-9][0-9]*$
>= 1 characters
transactionIdstringrequired
Unique identifier of the transaction the comment belongs to (positive integer encoded as a string)
Match pattern:^[1-9][0-9]*$
>= 1 characters
Response
application/json
Response
application/json
Returns the delete comment envelope
DeleteCommentResponse
* Additional properties are NOT allowed.
caseIdstring | null
Case identifier associated with the transaction. Populated on successful deletes.
isSuccessboolean
Indicates whether the operation was successful
messagestring | null
Human-readable message describing the result
statusstring | null
Status code of the operation (e.g., “Success”, “ValidationError”, “Failure”)
delete/market-connect/order-entry/v1/comments
Authentication
Body
{
"commentId": "54321",
"transactionId": "1125715"
}
application/json
Retrieves the comments for a transaction.
Returns the list of comments recorded against the specified transaction.
get
Query Parameters
pageinteger(int32)
1-based page number. Omit both page and pageSize to return all comments.
pageSizeinteger(int32)
Number of comments per page (1–100). Omit both page and pageSize to return all comments.
Path Parameters
transactionIdstringrequired
Unique identifier of the transaction (positive integer encoded as a string).
Response
application/json
Response
application/json
Returns the comments envelope
GetCommentsResponse
* Additional properties are NOT allowed.
caseIdstring | null
Case identifier associated with the transaction
dataobject
Comments data payload
* Additional properties are NOT allowed.
Show Child Parameters
isSuccessboolean
Indicates whether the operation was successful
messagestring | null
Human-readable message describing the result
statusstring | null
Status code of the operation
get/market-connect/order-entry/v1/comments/{transactionId}
Authentication
Path Parameters
Query Parameters
application/json