Skip to content

Set up your workspace

Name the organisation your keys, balance, orders and webhooks belong to, and add your team.

Sandbox: test money only. No request moves real money.

Before step 1 you create a workspace in your dashboard. A workspace is the organisation everything else belongs to: its keys, its balance, its orders and its webhooks.

Create a workspace

Give it a name of up to 100 characters. You become its owner, and it is a sandbox workspace: test money only, with every product the sandbox offers. You need a verified email first.

One person can create three workspaces in all, including any no longer used. Signing up never enables Live.

Add your team

An owner or an admin adds a teammate by email, with a role no higher than their own: owner, admin, developer, finance or viewer. The link is shown once. The teammate opens it and signs in with an account whose verified email is that address.

What an account is

A key belongs to one organisation in one environment. GET /account returns it: an id, a name, the environment the key works in, a kyb_status and the limits in force.

kyb_status is the verification state of the organisation. In the example it is sandbox_only. Verification belongs to live access; see Complete Live activation.

What you should see

Your dashboard opens in the new workspace. GET /account reads the same organisation once you have a key:

Code for What you should see
A sandbox workspace, read by its key
JSON
200 OKSynthetic sandbox data
{  "id": "org_01K7SAMP000000000000000090",  "name": "Example Business Ltd",  "environment": "sandbox",  "kyb_status": "sandbox_only",  "limits": {    "max_queued": 50  }}

If it fails

What you seeWhat to check
You cannot create a workspaceVerify your email first: a workspace needs a verified address.
You cannot create another workspaceOne person can create three workspaces in all, including any no longer used.
A teammate cannot acceptThey must sign in with an account whose verified email is the address you added, and the link is shown once. Add them again if it was lost.