Search
K
MarketConnect-OrderEntry

Cancels the e-signature ceremony for a case (voids the DocuSign envelope and returns the case to Pending upstream).

Voids the in-flight DocuSign envelope for the case and updates case status to Pending in Order Entry.

Request body:

  • transactionId (required, string) — must be a positive integer string for the case to cancel

Response: success and message. When success is false, message explains the failure in user-safe terms.

post

Body

application/json

Identifies the case whose e-signature ceremony should be canceled (void DocuSign; case returns to Pending).

* Additional properties are NOT allowed.
transactionIdstringrequired

String form of the transaction (case) id to cancel; must be a positive integer.

>= 1 characters

Response

application/json

Returns the cancel result envelope

CancelEsignatureCeremonyResponse

* Additional properties are NOT allowed.
successboolean

True when the DocuSign ceremony was voided and the case returned to Pending upstream.

messagestring | null

User-safe message when success is false; may also confirm the outcome when true.

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

Body

{ "transactionId": "1131068" }
 
application/json

Retriggers the DocuSign e-signature email notification for a case (only when e-signature is in progress upstream).

Asks Order Entry to resend the DocuSign signing notification for the case. Upstream AnnuityNet: POST RetriggerEsignatureEmail/{transactionId}. Only applies when e-signature is in progress; upstream returns success: false with a user-safe message otherwise.

Request body:

  • transactionId (required, string) — positive integer string for the case

Response: success and message (for example, notification successfully triggered when success is true).

post

Body

application/json

Identifies the case whose DocuSign signing notification should be resent (in-progress e-sign only).

* Additional properties are NOT allowed.
transactionIdstringrequired

String form of the transaction (case) id; must be a positive integer.

>= 1 characters

Response

application/json

Returns the retrigger result envelope

RetriggerEsignatureEmailNotificationResponse

* Additional properties are NOT allowed.
successboolean

True when the signing notification was retriggered (e-sign in progress upstream).

messagestring | null

User-safe message; e.g. notification successfully triggered when success is true.

post/market-connect/order-entry/v1/esignature/retrigger-email-notification

Body

{ "transactionId": "1131068" }
 
application/json

Updates signer email or phone for a case while e-signature is pending upstream.

Corrects signer email and/or phone while e-signature is pending upstream. AnnuityNet: POST UpdateESignSignerDetails with the same request payload.

Request body:

  • transactionId (required) — positive integer for the case
  • signers (required) — at least one signer row with corrected contact details

Each signer row: recipientId, signerEmail, signerSequence, signerAuthMethod (for example Phone), signerCountryCode, signerPhoneNo.

Response: success and message. When success is false, message explains the failure in user-safe terms.

post

Body

application/json

Transaction ID and signer rows with corrected email and/or phone while e-signature is pending upstream.

* Additional properties are NOT allowed.
transactionIdinteger(int64)

Transaction (case) identifier whose signer contact details should be updated.

>= 1

signersarray[object]required

Signer rows with corrected email and/or phone while e-sign is pending.

>= 1 items

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Returns the update result envelope

UpdateEsignSignerDetailsResponse

* Additional properties are NOT allowed.
successboolean

True when signer contact details were updated (e-sign must be pending upstream).

messagestring | null

User-safe message confirming the update or describing a failure.

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

Body

{ "transactionId": 1131068, "signers": [ { "recipientId": "11306862", "signerEmail": "corrected.email@zinnia.com", "signerSequence": "1", "signerAuthMethod": "Phone", "signerCountryCode": "1", "signerPhoneNo": "8650827071" } ] }
 
application/json

Health

Health check operations

Returns a simple health status indicating the API process is running.

Returns a simple health status. No authentication required.

get

Response

200

API is healthy

get/market-connect/order-entry/v1/health
 
200