← Hub

API Reference

Base URL: http://localhost:8080

Authenticate with Authorization: Bearer <token> on all protected endpoints.

Interactive API explorer available at http://localhost:5000/scalar/v1

Authentication

MethodPathAuthDescription
POST/v1/auth/tokenExchange API key for a 24h tenant JWT.
POST/v1/auth/admin/loginAdmin username/password → 8h admin JWT.
GET/v1/meTenant JWTReturn current tenant profile.
GET/v1/admin/meAdmin JWTReturn current admin profile.

Transfers

MethodPathAuthDescription
POST/v1/transfersTenant JWTCreate a new transfer (initiates VASP discovery).
GET/v1/transfersJWTList transfers (paginated).
GET/v1/transfers/:idJWTGet transfer detail.
GET/v1/transfers/:id/historyJWTStatus change audit trail.
PATCH/v1/transfers/:idAdmin JWTUpdate transfer (admin only).
DELETE/v1/transfers/:idAdmin JWTSoft-delete transfer.

Proof of Ownership

MethodPathAuthDescription
POST/v1/transfers/:id/pooJWTSelf-declaration PoO.
POST/v1/transfers/:id/poo/challengeJWTCreate EIP-191 signature challenge.
POST/v1/transfers/:id/poo/signatureJWTSubmit signed challenge.
POST/v1/transfers/:id/poo/satoshiJWTCreate Satoshi test challenge.
GET/v1/transfers/:id/poo/satoshi/:cidJWTPoll Satoshi challenge status.
POST/v1/transfers/:id/poo/satoshi/:cid/verifyJWTSubmit tx hash for Satoshi verification.
POST/v1/transfers/:id/poo/eid/sessionJWTCreate eID session.
GET/v1/transfers/:id/poo/eid/session/:sidJWTPoll eID session status.
GET/v1/poo/verifyJWTCheck PoO status for an address (?address=&chain=).

VASP Discovery

MethodPathAuthDescription
GET/v1/vasps/searchJWTSearch VASP directory (?q=).
GET/v1/addresses/lookupJWTLookup address (?network=&address=).
POST/v1/addresses/classifyJWTClassify an address (custodial vs self-hosted).

Dashboard

MethodPathAuthDescription
GET/v1/dashboard/transactionsJWTPaginated compliance transaction list.
GET/v1/dashboard/transactions/exportJWTDownload CSV of all transactions.
GET/v1/dashboard/transactions/:idJWTTransfer detail for dashboard.
GET/v1/dashboard/addressesJWTPaginated address registry.
GET/v1/dashboard/addresses/exportJWTDownload CSV of all addresses.
GET/v1/dashboard/addresses/:idJWTAddress detail.