Search
K
MarketConnect-OrderEntry

AttachmentResponse

object
* Additional properties are NOT allowed.
transactionIdstringrequired

Unique identifier for the Order Entry transaction.

>= 1 characters

caseIdstring

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":[]},{"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"},{"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},{"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."},{"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
Example

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

CommentItem

object
* Additional properties are NOT allowed.
commentIdstring

Unique identifier of the comment (positive integer encoded as a string)

commentSourcestring

Source system or user group that authored the comment

commentTextstring

Free-form comment text

createdDateTimestring

Date and time the comment was created

lastUpdatedDateTimestring

Date and time the comment was last updated

logonIDstring

Logon identifier of the user who authored the comment

statusAtStepstring

Status code of the transaction at the step the comment was added

statusDisplayNamestring

Display name for the status at the step the comment was added

stepTitlestring

Title of the wizard step the comment was added on

userNamestring

Name of the user who authored the comment

Example

CommentsData

object
* Additional properties are NOT allowed.
commentsarray[object]

List of comments for the current page

* Additional properties are NOT allowed.
Show Child Parameters
totalCountinteger(int32)

Total number of comments for the transaction across all pages

pageinteger(int32)

Current page number (1-based). Present when pagination query parameters are supplied.

pageSizeinteger(int32)

Number of comments per page. Present when pagination query parameters are supplied.

Example

CreateTransactionRequest

object
* Additional properties are NOT allowed.
statestring

Two-letter state, territory, or military mail code (e.g. GA, TX, DC, PR). Must be a recognized code.

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