API Docs / Schemas / EngagementAcceptanceStepDto

EngagementAcceptanceStepDto

A step in the engagement acceptance flow, computed server-side.

Properties

Name Type Description
keystring

Step identifier (e.g. "proposal", "engagement", "directDebit", "aml", "complete")

Step identifier (e.g. "proposal", "engagement", "directDebit", "aml", "complete")

labelstring

Display label for the step header

Display label for the step header

descriptionstring

Short description shown under the label

Short description shown under the label

isCompleteboolean

Whether this step has been completed

Whether this step has been completed

actionUrlstring

Action URL for this step (e.g. DD mandate URL, AML onboarding URL). Null if not applicable.

Action URL for this step (e.g. DD mandate URL, AML onboarding URL). Null if not applicable.

JSON Example

{
  "key": "string",
  "label": "string",
  "description": "string",
  "isComplete": false,
  "actionUrl": "string"
}

Contained in Schemas