Create an entity sandbox session

POST

/entity-sandbox-sessions

Exchanges the caller's authenticated dashboard session for a login session on the sandbox server, scoped to the sandbox shadow of the given entity. The authenticated identity must have an active resource-access record for the entity — either a wildcard * permission or the specific can_view_entity ACL flag — and the resolved entity sandbox must have completed activation. By default the entity's default sandbox (is_default: true) is used; pass sandbox_id to target a specific, non-default sandbox belonging to the entity instead. Use the returned session_token to authenticate directly against sandbox_base_url (for example, embedding an iframe or redirecting the caller into the sandbox environment).

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

A sandbox session was created successfully for the entity.

Bodyapplication/json

🟠400

🟠401

🟠403

Request Example

Shell

JavaScript

Java

Swift

cURL

Required fields only (uses the entity's default sandbox)Targeting a specific, non-default sandbox

curl --location '/entity-sandbox-sessions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "entity_id": "01JABC1234567890ABCDEFGHIJ"
}'

Response Example

201 - Success

{
    "message": "Entity sandbox session created successfully",
    "status": "success",
    "data": {
        "session_token": "sbx_sess_9f2a1c7d8e6b4a3f0912cdef",
        "sandbox_base_url": "https://sandbox.flutterwave.com"
    }
}

Modified at 2026-09-28 09:43:30

Retrieve public metadata for the authenticated entity

Retrieve one of your entities, including your membership