CHcheckout
Onboarding Simulator

Set entity status

Sandbox only — not available in Production.

Forces the entity to the specified status, bypassing normal onboarding flow. Use this to test how your integration handles different entity states.

post/simulate/entities/{entityId}/status

Request

Request body

status'draft' | 'requirements_due' | 'pending' | 'active' | 'restricted' | 'rejected' | 'inactive' required

The status to set on the entity.

Example request

{
  "status": "active"
}

Response

Status updated successfully

entity_idstring

The ID of the entity.

previous_statusstring

The status before the update.

current_statusstring

The status after the update.

Example response

{
  "entity_id": "ent_w4jelhppmfiufdnatam37wrfc4",
  "previous_status": "Pending",
  "current_status": "Active"
}

Changes

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