Search
K
MarketConnect-OrderEntry

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."}]}{"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

Ingests an EDS document attachment notification 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 - The specified transaction was not found.

  • 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

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

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

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.

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request body failed validation or required fields are missing.

  • INVALID_TRANSACTION_ID - The supplied transaction ID is invalid (not a positive integer).

  • 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 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 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

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

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

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