---
title: "Set entity status"
method: POST
path: "/simulate/entities/{entityId}/status"
tags: ["Onboarding Simulator"]
---

# Set entity status

`POST /simulate/entities/{entityId}/status`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/simulate/entities/{entityId}/status`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `string` scopes: `accounts`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/simulate/entities/:entityId/status/post.ts> (a function with typed inputs; its response is checked against the schema)

**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.

## Request body

- SimulatorSetStatusRequest
  - `status` 'draft' | 'requirements_due' | 'pending' | 'active' | 'restricted' | 'rejected' | 'inactive', required: The status to set on the entity.

## Response `200`

Status updated successfully

- SimulatorSetStatusResponse
  - `entity_id` string: The ID of the entity.
  - `previous_status` string: The status before the update.
  - `current_status` string: The status after the update.

## Other responses

- `202`: Status transition accepted and in progress
- `400`: Invalid status value or transition not allowed
- `401`: Unauthorized
- `404`: Entity not found
- `502`: Dependency error

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)