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.

Path Parameters
  • entityId
    Type: string
    required

    The ID of the entity.

Body·
required
application/json

The status to apply to the entity.

  • status
    Type: string enum
    required

    The status to set on the entity.

    values
    • draft
    • requirements_due
    • pending
    • active
    • restricted
    • rejected
    • inactive
Responses
  • application/json
  • application/json
  • application/json
  • 401

    Unauthorized

  • 404

    Entity not found

  • application/json
Request Example for post/simulate/entities/{entityId}/status
curl 'https://{prefix}.api.sandbox.checkout.com/simulate/entities/ent_w4jelhppmfiufdnatam37wrfc4/status' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "status": "active"
}'

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

Status updated successfully