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
Attachment
Attachment operations for transaction documents.
Retrieves the attachment payload (documents, required documents and rules) for a transaction.
Returns carrier/distributor context, source system, 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
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."}]}{"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}
Authentication
Path Parameters
application/json
Ingests an EDS document attachment notification for a transaction.
Records that an EDS document was added to or removed from a transaction.
Request body:
transactionId(required) — positive integer for the transactiondocumentId(required) — EDS document identifiersourceSystem(required) — originating system (for example,AnnuityNetorLifeSpeed)action(required) —addedordeleted
post
Body
application/json
Body
application/json
The document ingestion payload.
* Additional properties are NOT allowed.
transactionIdstringrequired
Unique identifier for the Order Entry transaction (positive integer encoded as a string).
Match pattern:^[1-9][0-9]*$
>= 1 characters
documentIdstringrequired
Electronic document service (EDS) identifier for the uploaded or deleted file.
>= 1 characters
sourceSystemstringrequired
Originating source system identifier (for example, AnnuityNet or LifeSpeed).
Allowed values:AnnuityNetLifeSpeed
>= 1 characters
actionstringrequired
Document lifecycle action. Allowed values: added, deleted.
Allowed values:addeddeleted
>= 1 characters
Response
application/json
Response
application/json
Returns the ingestion result envelope
IngestAttachmentDocumentResponse
* Additional properties are NOT allowed.
caseIdstring | null
Case identifier associated with the transaction.
isSuccessboolean
Indicates whether the ingestion operation was successful.
messagestring | null
Human-readable message describing the result.
statusstring | null
Status code of the operation (for example, Success, ValidationError, Failure).
post/market-connect/order-entry/v1/attachment
Authentication
Body
{
"transactionId": "123456",
"documentId": "6a3c4358bd44a9000c8d140e",
"sourceSystem": "AnnuityNet",
"action": "added"
}
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