Search
K
MarketConnect-OrderEntry

DocumentRule

object
* Additional properties are NOT allowed.
conditionsstring

Conditions under which the rule applies

keystring

Rule key

messagestring

Rule message shown to the user

valuestring

Rule value

Example

ErrorInfo

object
* Additional properties are NOT allowed.
codestringrequired

Backend error codes returned by the Order Entry API indicating validation failures, transaction issues, blueprint generation errors, authorization errors, or unexpected system failures.

Allowed values:VALIDATION_ERRORINVALID_TRANSACTION_IDINVALID_STEP_NAMETRANSACTION_CREATION_FAILEDTRANSACTION_ID_NOT_FOUNDSAVE_TRANSACTION_ERRORSAVE_TRANSACTION_FAILEDINVALID_RESPONSE_FORMATBUILD_BLUEPRINT_ERRORJSON_PARSE_ERRORTRANSFORMER_NULL_RESPONSEEMPTY_BLUEPRINTUNEXPECTED_ERRORSERVICE_ERRORUNAUTHORIZEDFORBIDDENNOT_FOUNDFIRST_STEP_SETUP_FAILED

descriptionstring
detailsstring
timestampstring(date-time)required
Example

ErrorResponse

object
* Additional properties are NOT allowed.
transactionIdstringrequired

>= 1 characters

errorsarray[object]required

Example:{"code":"VALIDATION_ERROR","description":"Input validation failed","details":"One or more input fields are invalid","timestamp":"2024-01-15T10:30:00.000Z"}

* Additional properties are NOT allowed.
Show Child Parameters
Example

EsignatureResponse

object
* Additional properties are NOT allowed.
successboolean

True when signers were retrieved successfully.

messagestring

User-safe message; populated when success is false.

signersarray[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
Example

EsignatureSigner

object
* Additional properties are NOT allowed.
recipientIdstring

DocuSign recipient ID from the recipient proc.

signerNamestring

Display name shown in the signer grid.

signerEntityRolestring

Entity role (for example PrimaryOwner, AgentOfRecord).

signerEmailstring

Signer email; may be empty for some roles.

signerSequencestring

Signing order when routing is sequential.

signerAccessCodearray[string]

Access codes when configured; empty array when none.

signerAuthMethodarray[string]

Array of auth method labels (for example Phone, SMS).

signerCountryCodestring

Country calling code (default 1 for US).

signerPhoneNostring

Phone digits only; stored without dashes in proc.

Example