Checkout.com API logo

Onboarding Simulator

Endpoints for driving entity state in sandbox environments. These endpoints are sandbox-only and return 404 in production. Use them to simulate status transitions and requirements-due scenarios when testing your integration.

Set requirements due

Sandbox only — not available in Production.

Marks the specified requirement fields as due on an entity. Use this to test how your integration handles the requirements-due state.

SecurityOAuth2: OAuth
Request
path Parameters
entityId
required
string

The ID of the entity.

Example: ent_w4jelhppmfiufdnatam37wrfc4
Request Body schema: application/json
required

The requirement fields to mark as due.

fields
required
Array of strings

The requirement fields to mark as due.
Call the List available requirements endpoint for a list of valid values.

Responses
200

Requirements due set successfully

400

Unknown or missing fields

401

Unauthorized

404

Entity not found

502

Dependency error

post/simulate/entities/{entityId}/requirements-due
Request samples
application/json
{
  • "fields": [
    ]
}
Response samples
application/json
{
  • "entity_id": "ent_w4jelhppmfiufdnatam37wrfc4",
  • "previous_status": "Active",
  • "current_status": "requirements_due",
  • "requirements_due": [
    ]
}

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.

SecurityOAuth2: OAuth
Request
path Parameters
entityId
required
string

The ID of the entity.

Example: ent_w4jelhppmfiufdnatam37wrfc4
scenarioId
required
string

The ID of the scenario to run.

Example: go_active
Responses
200

Scenario executed successfully

202

Scenario execution accepted and in progress

401

Unauthorized

404

Entity or scenario not found

502

Dependency error

post/simulate/entities/{entityId}/scenarios/{scenarioId}
Request samples 
Response samples 
application/json
{
  • "entity_id": "ent_w4jelhppmfiufdnatam37wrfc4",
  • "scenario_id": "go_active",
  • "scenario_name": "Go Active",
  • "previous_status": "RequirementsDue",
  • "current_status": "Active",
  • "requirements_due": [
    ]
}
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.


SecurityOAuth2: OAuth 
Request 
path Parameters
entityId
required
string
The ID of the entity.


 
 Example:  ent_w4jelhppmfiufdnatam37wrfc4
Request Body schema: application/json
required
The status to apply to the entity.


status
required
string
The status to set on the entity.


 Enum: "draft" "requirements_due" "pending" "active" "restricted" "rejected" "inactive"  
Responses 
200
Status updated successfully


202
Status transition accepted and in progress


400
Invalid status value or transition not allowed


401
Unauthorized


404
Entity not found


502
Dependency error


post/simulate/entities/{entityId}/status
Request samples 
application/json
{
  • "status": "active"
}
Response samples 
application/json
{
  • "entity_id": "ent_w4jelhppmfiufdnatam37wrfc4",
  • "previous_status": "Pending",
  • "current_status": "Active"
}
List available requirements
Sandbox only — not available in Production.


Returns all requirement fields that can be set as due on an entity. Use the field values when calling the Set requirements due endpoint.


SecurityOAuth2: OAuth 
Responses 
200
Requirements listed successfully


401
Unauthorized


404
Simulator not available in this environment. These endpoints are not registered in production.


get/simulate/requirements-due
Request samples 
Response samples 
application/json
[
  • {
    }
]
List scenarios
Sandbox only — not available in Production.


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


SecurityOAuth2: OAuth 
Responses 
200
Scenarios listed successfully


401
Unauthorized


404
Simulator not available in this environment. These endpoints are not registered in production.


get/simulate/scenarios
Request samples 
Response samples 
application/json
[
  • {
    }
]