Search
K
MarketConnect-OrderEntry

Esignature

E-signature signer retrieval and case submission for DocuSign (load recipients, then submit the case with signer roles, auth method, and contact details)

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

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

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