Search
K
MarketConnect-OrderEntry

SaveEsignatureRequest

object
* 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
Example

SaveEsignatureResponse

object
* Additional properties are NOT allowed.
successboolean

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

messagestring

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

Example

SaveEsignatureSignerRequest

object
* Additional properties are NOT allowed.
recipientIdstring

DocuSign recipient ID from GET signers (required for submission).

signerAccessCodestring

Access code when required; empty string when none.

signerAuthMethodstring

Selected auth method for submission (for example Phone).

signerCountryCodestring

Country calling code (default 1 for US).

signerEmailstring

Signer email; may be empty for some roles.

signerEntityRolestring

Entity role (for example PrimaryOwner, AgentOfRecord).

signerNamestring

Display name sent to DocuSign for this recipient.

signerPhoneNostring

Phone digits only; stored without dashes.

signerSequencestring

Signing order when routing is sequential.

Example

SectionBlueprint

object
* Additional properties are NOT allowed.
idstringrequired

The unique identifier for the section

>= 1 characters

sectionGroupKeystring

A key used to group related sections within the blueprint

partNamestringrequired

An identifier (partName) for the section

>= 1 characters

titleobjectrequired

The section title in multiple languages. Supports localization through language codes (e.g., en, fr)

* Additional properties are NOT allowed.
Show Child Parameters
modulesarray[string]

An array of module names associated with this section

isCustomboolean

Indicates whether this section is custom

subsectionsarray[object]

Array of subsections within this section

* Additional properties are NOT allowed.
Show Child Parameters
copyablestring

Role identifier controlling copy behavior. Use ‘none’ to disable copying, or a role name (e.g., ‘owner’, ‘annuitant’, ‘insured’, ‘payor’). Multiple roles may be comma-separated.

renderOnarray[string]

An array of conditions that determine when a section is rendered

pdfDocumentsarray[string]

An array of PDF document identifiers where this section appears

platformsarray[string]

An array of platforms where this section is available (e.g., D2C-only versus advisor-driven experiences)

visibleobject

Visibility conditions for the section. When present, the section is only visible when all conditions are met. Example: { “booleanOperator”: “AND”, “conditions”: [ { “type”: “equality”, “isEqual”: true, “value”: “NY”, “targetNodeId”: “SolicitationStateCode” } ] }

Example:{"booleanOperator":"AND","conditions":[{"type":"equality","isEqual":true,"value":"Yes","targetNodeId":"Transaction.SolicitationState"},{"type":"equality","isEqual":true,"value":"Yes","targetNodeId":"Transaction.SolicitationState"}]}

* Additional properties are NOT allowed.
Show Child Parameters
repeatableobject

Repeat-instance metadata when the wizard section declares IsRepeated.

* Additional properties are NOT allowed.
Show Child Parameters
Example

SectionGroupBlueprint

object
* Additional properties are NOT allowed.
idstringrequired

The unique identifier for the section group

>= 1 characters

titleobjectrequired

The section group title in multiple languages. Supports localization through language codes (e.g., en, fr)

* Additional properties are NOT allowed.
Show Child Parameters
partNamestring

An identifier (partName) for the section group

Example