Search
K
MarketConnect-OrderEntry

Retrieves the product pricing payload for a transaction.

Returns product pricing and fee schedules for the specified transaction.

Path parameter: transactionId (required) — resolves to the internal transaction; the caller must be authorized for this transaction.

Response envelope: caseId, transactionId, isSuccess, message, status, and optional data.

data (when isSuccess is true): flags (isApplicationTransaction, isVariableAnnuity, showMarketValueAdjustment, showNetManagementFee) plus productFees, featureFees, fundFees, surrenderCharges, and netManagementFees.

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:1064752

Response

application/json

Returns the product pricing payload

ProductPricingResponse

* Additional properties are NOT allowed.
caseIdstring | null

Case identifier associated with the transaction when pricing is found.

transactionIdstringrequired

Unique identifier for the Order Entry transaction.

>= 1 characters

dataobject

Fee schedules and product pricing detail; null when isSuccess is false.

Example:{"isApplicationTransaction":true,"isVariableAnnuity":true,"showMarketValueAdjustment":false,"showNetManagementFee":true,"productFees":[{"feeTypeLabel":"Base M&E charges:","feeName":"M&E","feeValue":"0.90%","isDefaultType":false},{"feeTypeLabel":"Annual Contract Amount:","feeName":"Contract fee","feeValue":"$120.00","isDefaultType":false}],"featureFees":[{"featureName":"Lifetime income rider","feeValues":["0.35%","$25 annual"],"riderModifiedChargeSchedule":[{"year":"1","charge":"2.00%"},{"year":"2","charge":"1.50%"}]}],"fundFees":[{"fundName":"Sample Index Fund","percentageDisplay":"0.85%","minPct":"0.50%","maxPct":"1.25%","amountDisplay":"","minAmt":"","maxAmt":"","isValueAdjusted":false}],"surrenderCharges":[{"year":"1","charge":"8%"},{"year":"2","charge":"7%"},{"year":"3","charge":"6%"}],"netManagementFees":[{"fundName":"Sample Index Fund","totalFeePercentage":"1.10%"}]}{"isApplicationTransaction":true,"isVariableAnnuity":true,"showMarketValueAdjustment":false,"showNetManagementFee":true,"productFees":[{"feeTypeLabel":"Base M&E charges:","feeName":"M&E","feeValue":"0.90%","isDefaultType":false},{"feeTypeLabel":"Annual Contract Amount:","feeName":"Contract fee","feeValue":"$120.00","isDefaultType":false}],"featureFees":[{"featureName":"Lifetime income rider","feeValues":["0.35%","$25 annual"],"riderModifiedChargeSchedule":[{"year":"1","charge":"2.00%"},{"year":"2","charge":"1.50%"}]}],"fundFees":[{"fundName":"Sample Index Fund","percentageDisplay":"0.85%","minPct":"0.50%","maxPct":"1.25%","amountDisplay":"","minAmt":"","maxAmt":"","isValueAdjusted":false}],"surrenderCharges":[{"year":"1","charge":"8%"},{"year":"2","charge":"7%"},{"year":"3","charge":"6%"}],"netManagementFees":[{"fundName":"Sample Index Fund","totalFeePercentage":"1.10%"}]}

* Additional properties are NOT allowed.
Show Child Parameters
isSuccessboolean

Whether the upstream product pricing call succeeded.

messagestring | null

Human-readable status message from the product pricing service.

statusstring | null

Status label (for example Success or Failure).

get/market-connect/order-entry/v1/productpricing/{transactionId}
 
application/json

Esignature

E-signature for DocuSign: load recipients, submit the case, poll signer status, cancel ceremony (void envelope; Pending), and retrigger signing email when in progress

Retrieves the e-signature signer list for a transaction.

Returns DocuSign signer details for the specified transaction.

Path parameter: transactionId (required) — resolves to the internal transaction; the caller must be authorized for this transaction.

Response fields:

  • success — whether signers were loaded
  • message — user-safe text when success is false
  • signers — recipient rows with recipientId, signerName, signerEntityRole, signerEmail, signerSequence, signerAccessCode, signerAuthMethod, signerCountryCode, signerPhoneNo

signerAuthMethod: array of labels (for example ["Phone", "SMS"]); signerAccessCode: string array.

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:1064752

Response

application/json

Returns the e-signature signer payload

EsignatureResponse

* Additional properties are NOT allowed.
successboolean

True when signers were retrieved successfully.

messagestring | null

User-safe message; populated when success is false.

signersarray | null[object]

DocuSign recipients for the transaction, ordered by signing sequence.

Example:{"recipientId":"11306862","signerName":"EE EE","signerEntityRole":"PrimaryOwner","signerEmail":"anannya.gupta@everglades.com","signerSequence":"1","signerAccessCode":[],"signerAuthMethod":["Phone","SMS"],"signerCountryCode":"1","signerPhoneNo":"8650827071"}

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

Retrieves DocuSign signer status for each recipient on a transaction.

Returns DocuSign routing status per recipient for the specified transaction (after the case is in flight).

Path parameter: transactionId (required) — resolves to the internal transaction; the caller must be authorized for this transaction.

Response fields:

  • success — whether status rows were loaded
  • signers — array of rows: recipientId, signerName, signerStatus, signerEmail, dateOfAction, signerAuthMethod (Phone | SMS | None), signerCountryCode (default 1 for US), signerPhoneNo (digits only)

signerStatus examples: Delivered, Needs to Sign, Needs to View, Waiting for Other Signer(s), Completed (Signed).

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:1064752

Response

application/json

Returns the signer status payload

EsignatureSignerStatusResponse

* Additional properties are NOT allowed.
successboolean

True when signer status rows were retrieved successfully.

signersarray | null[object]

Per-recipient DocuSign status and contact details for the transaction.

Example:{"recipientId":"11306862","signerName":"EE EE1","signerStatus":"Needs to Sign","signerEmail":"anannya.gupta@everglades.com","dateOfAction":"2026-01-12T14:22:00","signerAuthMethod":"Phone","signerCountryCode":"1","signerPhoneNo":"8650827071"}

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

Submits the Order Entry case for e-signature with the configured signer roster.

Submits the Order Entry case to DocuSign using the supplied signer roster. Call GET /esignature/{transactionId} first to load available recipients, then POST the selected signer contact and auth details here to start the e-signature workflow.

Request body:

  • transactionId (required) — positive integer for the case to submit
  • signers (required) — at least one signer row with final routing details

Each signer row: recipientId, signerName, signerEntityRole, signerEmail, signerSequence, signerAccessCode, signerAuthMethod (selected method, for example Phone), signerCountryCode, signerPhoneNo.

Response: success and message only (no signer list). message confirms submission when success is true.

post

Body

application/json

Case submission payload: transaction to submit and the final DocuSign signer roster (selected auth method per signer).

* Additional properties are NOT allowed.
transactionIdinteger(int64)

Transaction (case) identifier to submit for e-signature.

>= 1

signersarray[object]required

Final signer roster with selected auth method and contact details.

>= 1 items

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Returns the case submission result envelope

SaveEsignatureResponse

* Additional properties are NOT allowed.
successboolean

True when the case was submitted to DocuSign for e-signature.

messagestring | null

User-safe confirmation or failure text from the submission result.

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

Body

{ "transactionId": 1131068, "signers": [ { "recipientId": "11306862", "signerAccessCode": "", "signerAuthMethod": "Phone", "signerCountryCode": "1", "signerEmail": "anannya.gupta@everglades.com", "signerEntityRole": "PrimaryOwner", "signerName": "EE EE1", "signerPhoneNo": "8650827071", "signerSequence": "1" }, { "recipientId": "11306935", "signerAccessCode": "", "signerAuthMethod": "Phone", "signerCountryCode": "1", "signerEmail": "", "signerEntityRole": "AgentOfRecord", "signerName": "RR RR", "signerPhoneNo": "8650827071", "signerSequence": "2" } ] }
 
application/json