Search
K
MarketConnect-OrderEntry

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@zinnia.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@zinnia.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

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