Nuvanté Technologies logo

API reference

Sandbox endpoint catalogue

The reference for the Nuvanté sandbox API. Browse endpoints by theme, check their parameters, and copy request samples along with their response envelopes.

Sandbox APIhttps://sandbox-api.nuvante.io

A good order to work through: authentication, then the system readiness check, then balances, then redemptions or swaps. The guides live under /developers/docs, and this catalogue is the detailed, endpoint-by-endpoint reference.

Authentication

API key credentials and how auth works today.

GET/api/v1/system/status

Authenticate with an API key

Send a participant-scoped sandbox API key as a Bearer token.

Open

System

Readiness checks to run before you start a settlement flow.

GET/api/v1/system/status

Get system status

Check that the engine, the on-chain probe and the settlement adapter are ready.

Open

Accounts & balances

Participant identity, balances and reserve visibility.

GET/api/v1/me

Get current participant

Returns the participant your API key belongs to.

Open
POST/api/v1/onboarding/applications

Submit onboarding application

Apply once to get sandbox access straight away, and production access after a KYB review.

Open
GET/api/v1/me/balances

List balances

Read the balances your participant can see.

Open
GET/api/v1/reserves

List reserves

Read issuer reserve positions, if your credential has reserve access.

Open

Transactions

Initiate, fetch, list and cancel settlement transactions.

GET/api/v1/transactions

List transactions

Page through your participant's transactions.

Open
GET/api/v1/transactions/{id}

Get a transaction

Fetch one transaction, including its saga state and available actions.

Open
POST/api/v1/transactions

Initiate a transaction

Create a redemption or a stable-to-stable swap.

Open
POST/api/v1/transactions

Initiate a stable-to-stable swap

Create a swap between two issued assets.

Open
POST/api/v1/transactions/{id}/cancel

Cancel a transaction

Cancel a transaction while cancelling is still allowed.

Open
GET/api/v1/transactions/{id}/recovery-status

Get transaction recovery status

See the Mode 3 recovery state and refund timeline for a transaction.

Open

Reserve proofs

Generate and verify ZK reserve proofs for issuer backing claims.

POST/api/v1/reserves/{issuerId}/proof/generate

Generate reserve proof

Generate a fresh ZK reserve proof from the issuer's current sandbox reserves.

Open
POST/api/v1/reserves/proof/verify

Verify reserve proof

Check any proof artifact against the sandbox policy key.

Open
GET/api/v1/reserves/{issuerId}/proof

Get latest reserve proof

Fetch an issuer's most recent proof and its verification result.

Open

Agents

Mint agent identities, scope their mandates with capability intersection, and revoke them. Cross-platform interoperability is planned for Phase 2.

POST/api/v1/sandbox/agents

Mint sandbox agent

Create a sandbox agent identity with a scoped mandate.

Open
GET/api/v1/sandbox/agents

List sandbox agents

List the active sandbox agent mandates for your participant.

Open
GET/api/v1/sandbox/agents/{id}

Get sandbox agent

Fetch one sandbox agent mandate by ID.

Open
POST/api/v1/sandbox/agents/{id}/revoke

Revoke sandbox agent

Revoke a sandbox agent's mandate straight away.

Open

Issuers

Issuer capability declaration, the burn and mint instruction contract, and conformance testing.

PUT/api/v1/issuers/{issuerId}/capabilities

Declare issuer capabilities

Create or update the capability profile that controls how Nuvanté orders your transactions.

Open
POST/api/v1/issuers/{issuerId}/custody/verify-delegation

Verify custody delegation

Confirm that Nuvanté's operator key is an on-chain co-signer before Mode 1 goes live.

Open
POST/api/v1/issuers/{issuerId}/conformance/run

Run issuer conformance

Run the full conformance suite against the issuer's declared `apiBaseUrl`.

Open
GET/api/v1/issuers/{issuerId}/conformance/results

Get issuer conformance results

Get the pass or fail result for each scenario in the latest conformance run.

Open

Conformance

Arm sandbox issuer outcomes on transactions you own. Needs a tenant admin JWT, and isn't available in production.

POST/api/v1/conformance/run

Arm a conformance scenario

Set up a sandbox issuer outcome (`rejected`, `failed` or `silence`) on a transaction you own.

Open

Tools

Public helpers behind the docs-site self-check and the onboarding dry run.

POST/api/v1/tools/integration-path

Build integration path

Turn your answers about how you operate into an ordered reading list (this powers Find your path).

Open

Team

Invite and manage participant team members with a tenant admin JWT.

GET/api/v1/team

List team members

List the active members of your participant.

Open
POST/api/v1/team/invitations

Create team invitation

Invite someone to join your participant.

Open
POST/api/v1/team/invitations/{id}/resend

Resend team invitation

Send a pending invitation email again.

Open
POST/api/v1/team/invitations/{id}/revoke

Revoke team invitation

Cancel a pending invitation straight away.

Open

Webhooks

Subscribe to transaction lifecycle events. Deliveries are signed with HMAC-SHA256 in a `Nuvante-Signature` header.

POST/api/v1/webhooks

Register webhook endpoint

Subscribe to transaction lifecycle events.

Open
GET/api/v1/webhooks

List webhook subscriptions

List every webhook subscription for your participant.

Open
GET/api/v1/webhooks/{id}

Get webhook subscription

Fetch one webhook subscription by ID.

Open
DELETE/api/v1/webhooks/{id}

Delete webhook subscription

Remove a webhook subscription and stop all future deliveries.

Open