API reference

Every route of the Neo Wallet API, generated from its OpenAPI 3.1.0 document — the same one that is tested against the running API on every release. Import it into your own tooling: openapi.json.

All routes need the four authentication headers. Writes also need Idempotency-Key and X-Request-Id — see Safe retries.

Route	Does	Scope
POST /customers	Onboard a customer and open its main wallet	customers:write
GET /customers/{uid}	Customer summary: status, KYC, wallets, identifiers, agreements, mandates	customers:read
GET /customers/{uid}/identifiers	List a customer's identifiers, masked	customers:read
POST /customers/{uid}/identifiers	Attach an identifier to a customer	customers:write
PATCH /customers/{uid}/identifiers/{iid}	Update an identifier's verification state	customers:write
GET /customers/{uid}/agreements	List a customer's document acceptances	customers:read
POST /customers/{uid}/agreements	Record a customer's acceptance of a document	customers:write
POST /customers/{uid}/kyc-versions	Submit a KYC update or KYC level change for a customer	customers:write
GET /wallets/{uid}/balance	Current, held and available balance of one wallet	wallets:read
GET /wallets/{uid}/transactions	Paginated statement of one wallet, newest first	wallets:read
POST /wallet-credits	Credit a customer wallet from your prefunded balance	wallet-credits:write
POST /wallet-debits	Debit a wallet with the customer freshly authenticated	wallet-debits:write
GET /mandates	List your mandates, newest first	mandates:read
POST /mandates	Register a customer's standing consent to be debited	mandates:write
GET /mandates/{uid}	Get one of your mandates	mandates:read
POST /mandates/{uid}/revoke	Revoke one of your mandates	mandates:write
POST /mandates/{uid}/debits	Debit a wallet on a standing mandate, customer not present	wallet-debits:write
POST /fees/quote	Quote fee, tax and total before submitting an operation	wallets:read
POST /payouts	Pay out to the customer's own verified contact identifier	payouts:write
POST /topup-intents	Issue a top-up reference the customer quotes when paying	topup-intents:write
GET /topup-intents/{uid}	Get one top-up intent's status and state timeline	operations:read
GET /operations	List your operations, newest first	operations:read
GET /operations/{uid}	Get one operation's status and state timeline	operations:read
GET /operations/{uid}/receipt	Get the receipt of one operation	operations:read
GET /health	Liveness probe	—
GET /openapi.json	OpenAPI 3.1 description of the Neo Wallet API	—

Paths are shown without the /api/v1/tenant prefix every route carries.