Your first sandbox request

This page takes you from zero to your first settled sandbox transaction. You'll get access, create a key, check the platform is ready, send one redemption, poll it until it finishes, and then pick your track. The rest of the docs assume you've done these steps.

1. Apply for access

Start with Self-service onboarding. You get sandbox access as soon as you apply. Production access comes later, after a KYB review of the same application.

2. Create a sandbox API key

Sign in at https://sandbox.nuvante.io with WorkOS. Keys are created from your portal session, which carries the manageApiKeys capability. An nvt_sandbox_ key can't create or revoke other keys.

You'll only see the secret once, so store it on your server straight away.

Manage sandbox API keys

Give the key only the scopes you need. To initiate transactions you'll need transactions:write. The full list of scopes is on the Authentication page.

3. Portal or API

You can use both from day one, as soon as your organisation is provisioned.

In the portal at https://sandbox.nuvante.io you can create keys, invite teammates and run sandbox examples using your signed-in session. Please don't paste an API key into the browser.

/developer/console has ready-made examples. Every "Try in sandbox" link in these docs lands here.
/initiate is a form wizard for clearing members who hold initiateTransaction.

4. Check readiness

Run this before you initiate anything. In sandbox, a connected RTGS state tells you the mock settlement adapter is up. There's no live Bank of England connection behind it.

Code sample

curl "https://sandbox-api.nuvante.io/api/v1/system/status" \
  -H "Authorization: Bearer nvt_sandbox_your_key"

Try in sandbox

5. Initiate one redemption

Use the issuer and asset identifiers assigned to your sandbox participant. Sandbox assets explains where to find them. Send a unique Idempotency-Key header with every request that changes something. The full request schema is in Initiate transaction.

Try in sandbox

6. Poll until terminal

Poll GET /api/v1/transactions/{id} with the ID you got back in step 5, and stop once you see terminal: true. Please rely on that flag alone and avoid piecing the answer together from the chain or RTGS fields. Transaction lifecycle covers this in more detail.

Code sample

curl "https://sandbox-api.nuvante.io/api/v1/transactions/{transactionId}" \
  -H "Authorization: Bearer nvt_sandbox_your_key"

7. Pick your track

Once your first poll comes back terminal, move on to your role guide. Each one is an ordered checklist that links out to the detailed pages.

Before you write production code, spend three minutes on Platform concepts. To see which settlement modes you can try in sandbox, read Sandbox trial.