CHcheckout
Onboarding Simulator

Run scenario

Sandbox only — not available in Production.

Executes a pre-defined scenario against an entity, triggering the associated state transition or capability change. Use GET /simulate/scenarios to list available scenario IDs.

post/simulate/entities/{entityId}/scenarios/{scenarioId}

Request

Response

Scenario executed successfully

entity_idstring

The ID of the entity.

scenario_idstring

The ID of the scenario that was run.

scenario_namestring

The name of the scenario that was run.

previous_statusstring

The entity status before the scenario ran.

current_statusstring

The entity status after the scenario ran.

requirements_duestring[]

Requirement fields applied by the scenario, if any.

Example response

{
  "entity_id": "ent_w4jelhppmfiufdnatam37wrfc4",
  "scenario_id": "go_active",
  "scenario_name": "Go Active",
  "previous_status": "RequirementsDue",
  "current_status": "Active",
  "requirements_due": [
    "individual.identification.document"
  ]
}

Changes

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