CHcheckout
Onboarding Simulator

List scenarios

Sandbox only — not available in Production.

Returns all pre-defined scenarios available. Use the scenario IDs when calling the run scenario endpoint.

get/simulate/scenarios

Request

Response

Scenarios listed successfully

idstring

The unique identifier of the scenario.

namestring

Human-readable name of the scenario.

descriptionstring

Description of what the scenario does.

actionstring

The action type performed by this scenario.

statusstring

The resulting entity status after the scenario runs. Empty string for non-status actions.

requirements_duestring[]

Requirement fields applied when the scenario runs, if any.

Example response

[
  {
    "id": "go_active",
    "name": "Go Active",
    "description": "Transitions the entity to active status.",
    "action": "set_status",
    "status": "active",
    "requirements_due": [
      "individual.identification.document"
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.