> For the complete documentation index, see [llms.txt](https://vnx.gitbook.io/vnx-global/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vnx.gitbook.io/vnx-global/developer/overview.md).

# Overview

*Issue, redeem, convert, and orchestrate fiat-backed stablecoin payments through one regulated, programmable API.*

## Overview

The VNX Developer Platform exposes the same regulated rails that power VNX Global Ltd's institutional stablecoin business — minting and redemption of VCHF and VGBP, and crypto on/off-ramp conversion — through a signed REST API and a hosted dashboard. It is built for integration engineers at exchanges, OTC desks, fintechs, treasury platforms, and Web3 infrastructure providers who need a Bermuda Class M licensed counterparty rather than an unregulated wrapper.

This portal documents the integration surface: a Quickstart for first credentials, Concepts that translate VNX's custody, compliance, and reserve architecture into developer terms, Flows that mirror the verified operations diagrams, Guides for end-to-end product implementations, and an API reference.

Every `/private/*` request is authenticated with an ECDSA key-pair — there is no OAuth — and signed with three headers. The API has no webhooks: you poll the query endpoints (`querySupplyChanges`, `queryPayments`, `queryPaymentRails`) for status. Base URLs are `https://api.uat.vnx.io/api/v1/` (test) and `https://api.vnx.io/api/v1/` (production).

## Key benefits

* **Regulated stablecoin issuance on demand** — call a single mint endpoint and VNX moves customer fiat into the fiduciary reserve before tokens are issued, so the underlying compliance happens server-side.
* **One on/off-ramp surface across BTC, ETH, GBP, and CHF** — a single payment-rail call (`addPaymentRail`) brokered through regulated third-party providers replaces multi-vendor integrations on the client side.
* **Built-in segregation, Travel Rule, and audit trail** — every transaction inherits the platform's segregated wallets, AML screening, and five-year audit-log retention without additional implementation work on the integrator side.

## Use cases

* **Exchange or OTC desk** — wire customer fiat in, mint VCHF or VGBP, deliver to a whitelisted external wallet for liquidity-pool seeding.
* **Treasury / FX platform** — quote a same-day BTC-to-GBP off-ramp inside a corporate workflow with a confirmable rate window.

## Where to start

```mermaid
flowchart LR
    A[Read Overview] --> B[Quickstart: prerequisites + first signed call]
    B --> C[Concepts: ECDSA auth, wallets, Travel Rule]
    C --> D[Flows: mint, redeem, exchange]
    D --> E[Guides: end-to-end integrations]
    E --> F[API reference]
```

## Prerequisites

* A signed VNX onboarding agreement and completed KYB.
* An ECDSA key-pair: register the public key with VNX; keep the private key to sign requests. Test (UAT) and production credentials are issued by the VNX onboarding team.
* A `User-Agent` string set on every request, and respect for the 1 request/second per-public-key rate limit.
* For external wallet delivery, at least one whitelisted on-chain address with Travel Rule data captured.

## Concepts you will need

* Authentication — ECDSA key-pair signing with the three `x-app-*` headers.
* Balances — Platform balance versus whitelisted external wallets.
* Nonce and retries — nonce-based replay safety for signed writes.
* Travel Rule — when and how it gates a flow.
* Blockchains and tokens — VCHF (6 chains) and VGBP (4 chains) coverage.

## Related

* [Stablecoins](/vnx-global/institutional/products/stablecoins.md)
* [Minting and Redemption](/vnx-global/institutional/products/minting-and-redemption.md)
* [On Off ramp](/vnx-global/institutional/products/on-off-ramp.md)
* [Standards and Contracts](/vnx-global/transparency/standards-and-contracts.md)
* [Glossary](/vnx-global/glossary.md)