v1API V1 · COMPATIBILITY REFERENCE
The complete legacy surface, now searchable.
This catalog preserves the published v1 documentation while every operation is reconciled with the running account, identity, and Core systems.
QUICK REFERENCE
V1 endpoint directory
Choose an operation to see the imported parameters, request bodies, response examples, and known variants.
Authentication
11 endpoints · User onboarding · Account access
/api/v1/auth/seedSeeds are required and needed when passing around passwords and very sensitive information.
/api/v1/auth/seedsThis endpoint returns all seeds for cross-tenant activated users.
/api/v1/auth/loginAs described in the "AUTH: Get Seed" Endpoint, before the login credentials can be passed to the backend, the seed must be requested using the appropriate parameters.
/api/v1/auth/verifyThis Endpoint allows a third-party system to check and verify a bearer token against the Perpetuals.com system.
/api/v1/auth/logoutThis end-point will log the user out of any API-based sessions on all devices.
/api/v1/auth/registrationThis end-point allows a new private user to be registered/signed-up (please see the "Register a Corporate User" Endpoint for companies/corporations).
/api/v1/auth/new2facodeTo start the 2FA Initiation process, a 2FA Initiation Key must be generated.
/api/v1/auth/submitfirst2facodeTo "link" the 2FA Code to the Account, a first code needs to be submitted to the system to verify that the 2FA Mechanism has generated a valid token on the client's Authenticator Software app.
/api/v1/auth/reset2faThis endpoint allows for users to reset their Multi-Factor Code using either a valid bearer token or a matching and correct client_id and encrypted master password combination in the payload.
/api/v1/auth/federateThis endpoint allows a logged in user to use their bearer token to generate a web-link that automatically logs them into the web-interface of the platform.
/api/v1/auth/close_accountThis Endpoint permanently closes the User's Account.
User Profile Data
20 endpoints · Embedded accounts · User onboarding
/api/v1/profile/resetpasswordThis Request sends a password reset link (code) to the user's email address (if the email address exists in the system).
/api/v1/profile/activate/XXXXXXXXThis Request activates an account by submitting the activation code from the email sent to the user.
/api/v1/profile/newpasswordThis endpoint is used when setting the new password from a password reset request.
/api/v1/profile/setpasswordThis endpoint is only needed when changing the password without a password reset function involved - it requires the old password.
/api/v1/profile/personaldataProfile Data can be updated by using the following keys/values.
/api/v1/profile/metadataCustom Meta Data for Profiles can be updated by using the following keys/values.
/api/v1/profile/advanceddataThis endpoint allows for additional/advanced data to be submitted and passed through to other third-party systems.
/api/v1/profile/advanceddataUse this Endpoint to get the submitted Advanced Data.
/api/v1/profile_basicUse this Endpoint to get information, transactions, balances, logs, etc.
/api/v1/profileUse this Endpoint to get a full download of information, transactions, balances, logs, etc.
/api/v1/profile/avatarGet Profile Avatar Image.
/api/v1/profile/uploadavatarUpload Profile Avatar Image.
/api/v1/profile/whitelabelThis Endpoint returns information about the Whitelabel which the user is assigned to.
/api/v1/profile/bank_accountsGet Linked Bank Accounts.
/api/v1/profile/featuresGet Enabled Features.
/api/v1/profile/last_loginsGet Last Logins.
/api/v1/profile/referral_dataGet Referral Data.
/api/v1/profile/togglesymbolwatchlistProfile Data can be updated by using the following keys/values.
/api/v1/profile/market_watchlistGet Symbol Watchlist.
/api/v1/wallet/balancesGet Wallet Balances.
Session Management
3 endpoints · Embedded accounts
/api/v1/sessions/activeUse this Endpoint to get information, transactions, balances, logs, etc.
/api/v1/sessions/newUse this Endpoint to get information, transactions, balances, logs, etc.
/api/v1/sessions/destroyUse this Endpoint to get information, transactions, balances, logs, etc.
Workspace Management
11 endpoints · White-label platforms · Enterprise operations
/api/v1/workspaces/allThis Endpoints returns a list of available Workspaces for a given user, identified through their bearer token.
/api/v1/workspaces/createThis Endpoint marks the first step in creating a new Workspace.
/api/v1/workspaces/seedThis Endpoint is needed as an intermediary step before setting the new master password which secures the Workspace's Digital Asset Vault.
/api/v1/workspaces/secureThis Endpoint finalizes the creation of a new workspace by securing it via the Master Password.
/api/v1/workspaces/detailsThis Endpoint returns all details and meta-data of a workspace, including members within a workspace and their status.
/api/v1/workspaces/inviteThis Endpoint is used to invite a new user to a workspace.
/api/v1/workspaces/revokeThis Endpoint is used to invite a new user to a workspace.
/api/v1/workspaces/accept/XXXXXXXThis Endpoint allows the user to accept a workspace invitation using the activation code from their invitation email.
/api/v1/workspaces/roleThis Endpoints changes the Workspace Role of a user.
/api/v1/workspaces/activeThis Endpoint returns all details and meta-data of a workspace, including members within a workspace and their status.
/api/v1/workspaces/activateThis Endpoints sets the active Workspace of a user.
Vault / Wallet Functions
20 endpoints · Embedded wallets · Global remittance · Treasury
/api/v1/wallet/depositThis end-point returns the Public Keys per Wallet Currency of the Account.
/api/v1/wallet/additional_deposit_options_linkThis end-point returns a URL Link that can be shown in the browser (or within an iFrame, or Web-View on a mobile device) which will allow the user to buy crypto via their Credit/Debit Cards and other payment methods depe
/api/v1/wallet/verifyuserThis helps users validate an Email address, Username, or MSISDN (international phone number) before sending funds using the "Send to a Friend" function.
/api/v1/wallet/verifyaddressThis helps users validate an external crypto wallet address before adding it to the External Address Whitelist.
/api/v1/wallet/securesendThe Secure Send system (formerly "send to a friend") is a powerful solution that allows for quick and convenient sending of any size and type of funds or digital assets between users on the Hybrid-Chain system (even betw
/api/v1/wallet/addwalletThis Endpoint is used to add an external wallet (to withdraw to) to the user's address book and whitelists it.
/api/v1/wallet/withdrawalwalletsThis Endpoint returns a list of all whitelisted external wallets in the user's address book.
/api/v1/wallet/removewalletThis Endpoint removes an entry from the user's external wallet address book.
/api/v1/wallet/withdrawNote: The encrypted master password must be hashed the same way as when setting the master password (by first calling the master_password_seed endpoint and hashing it with the concatinated password (Described in the Set
/api/v1/wallet/transferThis Endpoints allows users to transfer liquidity between their self-custody wallet and their Hybrid Wallet.
/api/v1/wallet/swapThe Swap/Convert system is an easy and efficient solution that allows for quick and cheap conversions between currencies and digital assets.
/api/v1/walletThis end-point delivers some quick information on buying power and currencies held in the wallets throughout all currencies in real-time exchange-rates.
/api/v1/wallet/transactionsThis Endpoint returns a list of all transactions made by the user (includes deposits, conversions, withdrawals, etc.).
/api/v1/wallet/ico_tokensGet All Available ICO Tokens.
/api/v1/wallet/master_password_seed&email=0Seeds are required and needed when passing around passwords and very sensitive information.
/api/v1/wallet/setmasterpasswordThe Master Password acts as a recovery key in the event where the 2-FA Device or Biometrics are lost or inaccessible.
/api/v1/wallet/sign_payloadThis endpoint is used to sign arbitrary JSON payloads against a user's vault (RSA Private key).
/api/v1/wallet/transitkeyA Transit RSA Key can be used to secure data being moved and stored though the system.
/api/v1/wallet/invalidatersakeyA Transit RSA Key can be used to secure data being moved and stored though the system.
/api/v1/wallet/estimateEstimate Transaction Fees.
Payment Functions
6 endpoints · Crypto checkout · Global payments
/api/v1/pay/new_payment_requestGenerating the Payment Request is the first step in requesting funds for payment of goods and services.
/api/v1/pay/get_payment_request_detailsOn the customer's side of the transaction, the QR Code generated from the "Create new Payment Request" Endpoint is scanned, which returns a payment hash (and more).
/api/v1/pay/pay_payment_requestThe Preferred Currency can be submitted (optionally) to allow the request to be paid in that specific currency from the sender.
/api/v1/pay/get_payment_requestsThis Endpoint returns a list of all Payment Requests generated.
/api/v1/pay/new_multi_paymentLeveraging the Secure Send functionality, this Endpoint allows you to initiate mass payments to thousands of users, instantly and globally.
/api/v1/pay/new_pix_payment_requestThis Endpoint creates a new PIX Payment Request that returns a PIX Payment QR Code (and payment Link, along with other reference and tracking data).
Merchant Functions
16 endpoints · Crypto checkout · Merchant settlement
/api/v1/merchant/overviewGet Merchants Overview.
/api/v1/merchant/allGet All Merchants.
/api/v1/merchant/createGenerating the Payment Request is the first step in requesting funds for payment of goods and services.
/api/v1/merchant/detailsGet Merchant Details.
/api/v1/merchant/detailsSet Merchant Details.
/api/v1/merchant/enabled_statusGenerating the Payment Request is the first step in requesting funds for payment of goods and services.
/api/v1/merchant/new_invoiceGenerating the Payment Request is the first step in requesting funds for payment of goods and services.
/api/v1/merchant/cancel_invoiceOrders can be cancelled only if they are unpaid.
/api/v1/merchant/checkoutGet Checkout Data.
/api/v1/merchant/invoice_statusGet Invoice Status.
/api/v1/merchant/all_invoicesGet All Invoices.
/api/v1/merchant/reserve_walletReserving a Payment Wallet allows for a single email-address of a user to be used as an identifier between the systems for repeated and unsolicited deposits.
/api/v1/merchant/rotational_walletsGet All Rotational Wallets.
/api/v1/merchant/sync_rotational_walletsSync All Rotational Wallets.
/api/v1/merchant/settle_balancesThis endpoint settles all balances of all currencies of a list of rotational wallets.
/api/v1/merchant/settlementsGets a list of all previous settlements and their status.
Decentralized Trading
11 endpoints · Digital-asset exchange
/api/v1/dex/marketsReturns an overview of all available markets on the Decentralized Exchange.
/api/v1/dex/market_historyReturns chart-data for the indicated market in various timeframes ('minute', 'hour', 'day').
/api/v1/dex/market_chartReturns chart-data for the indicated market in various timeframes ('minute', 'hour', 'day').
/api/v1/dex/orderbookGets the real-time orderbook depth (asks/bids) for a given market.
/api/v1/dex/tradesReturns a list of executed Trades of the last 10 minutes for a given market.
/api/v1/dex/trade_metaReturns a list of executed Trades of the last 10 minutes for a given market.
/api/v1/dex/ordersReturns a list of executed Trades of the last 10 minutes for a given market.
/api/v1/dex/order_metaReturns a list of executed Trades of the last 10 minutes for a given market.
/api/v1/dex/create_orderReturns a list of executed Trades of the last 10 minutes for a given market.
/api/v1/dex/cancelReturns a list of executed Trades of the last 10 minutes for a given market.
/api/v1/dex/cancel_allReturns a list of executed Trades of the last 10 minutes for a given market.
Securities Trading
14 endpoints · Digital-asset exchange · Institutional trading
/api/v1/exchange/marketsReturns an overview of all available markets on the Exchange.
/api/v1/exchange/fundingratesReturns an overview of all available markets on the Exchange and their corresponding funding rates.
/api/v1/exchange/orderbookGets the real-time orderbook depth (asks/bids) for a given market.
/api/v1/exchange/orderbook_restrictionsGets the real-time orderbook depth (asks/bids) for a given market.
/api/v1/exchange/ordersReturns a list of all orders (and all statuses), including trading id's as references (if any fills were executed).
/api/v1/exchange/order_metaReturns details and meta data of a particular order, identified by it's id on the request (includes trade id references where fills have been executed, or market surveilance violations, if any).
/api/v1/exchange/tradesReturns a list and details of all trades in context to the requestee.
/api/v1/exchange/trade_metaReturns details and meta data of a particular trade, identified by it's id on the request.
/api/v1/exchange/market_historyReturns a list of all markets of a given liquidity pool with their last trades per market.
/api/v1/exchange/last_pricesReturns a list of all markets of a given liquidity pool with their last execution price per market.
/api/v1/exchange/eventsReturns an overview of all available markets on the Exchange.
/api/v1/exchange/create_orderCreates an order with the parameters specified (MARKET).
/api/v1/exchange/cancelCancels one or multiple orders given in the list within the payload.
/api/v1/exchange/cancel_allKills all orders in a given liquidity pool.
Virtual Exchange
9 endpoints · Digital-asset exchange
/api/v1/virtex/marketsReturns an overview of all available markets on the Exchange.
/api/v1/virtex/orderbookGets the real-time orderbook depth (asks/bids) for a given market.
/api/v1/virtex/ordersReturns a list of all orders (and all statuses), including trading id's as references (if any fills were executed).
/api/v1/virtex/order_metaReturns details and meta data of a particular order, identified by it's id on the request (includes trade id references where fills have been executed, or market surveilance violations, if any).
/api/v1/virtex/tradesReturns a list and details of all trades in context to the requestee.
/api/v1/virtex/trade_metaReturns details and meta data of a particular trade, identified by it's id on the request.
/api/v1/virtex/create_orderCreates an order with the parameters specified (MARKET).
/api/v1/virtex/cancelReturns a list of executed Trades of the last 10 minutes for a given market.
/api/v1/virtex/cancel_allReturns a list of executed Trades of the last 10 minutes for a given market.
Tokenized Securities
9 endpoints · Tokenized ownership · Asset issuance
/api/v1/tokens/securitiesReturns a list of all available Securities (even if they have not been minted).
/api/v1/tokens/availableReturns a list of all available Security Tokens.
/api/v1/tokens/detailsReturns the details of an individual token by uuid.
/api/v1/tokens/inventoryReturns the available inventory/supply/reserve per token uuid.
/api/v1/tokens/quoteReturns an approximate Price Quote for a given token uuid.
/api/v1/tokens/performanceReturns the approximate price performance of a given token uuid.
/api/v1/tokens/buying_powerReturns the buying power available for a given token uuid.
/api/v1/tokens/mintMints and creates a new token.
/api/v1/tokens/redeemReturns the redemption/reserve addresses to send tokens to.
Prediction Markets
4 endpoints · Prediction markets
/api/v1/prediction/allReturns a list of all available Security Tokens.
/api/v1/prediction/detailsReturns the details of an individual token by uuid.
/api/v1/prediction/performanceReturns the approximate price performance of a given token uuid.
/api/v1/prediction/createMints and creates a new token.
Barrier Product Constructor
9 endpoints · Structured products
/api/v1/barriers/availableReturns a list of all available Barrier Products.
/api/v1/barriers/detailsReturns the details of an individual Barrier Product.
/api/v1/barriers/performanceReturns the approximate price performance of a given token uuid.
/api/v1/barriers/quoteMints and creates a new token.
/api/v1/barriers/issueCreates/Issues a new Barrier Product (effectively opens a position).
/api/v1/barriers/closeCloses a list of Barrier Products identified through their UUIDs (effectively sells the positions).
/api/v1/barriers/positionsReturns the available inventory/supply/reserve per token uuid.
/api/v1/barriers/historyReturns the available inventory/supply/reserve per token uuid.
/api/v1/barriers/portfolioReturns the approximate price performance of a given token uuid.
NFT Super Store
25 endpoints · Asset marketplace · Digital collectibles
/api/v1/nft/categories/allGet All NFT Categories.
/api/v1/nft/collections/allGet All Collections.
/api/v1/nft/collections/itemsGet All Collection Items.
/api/v1/nft/collections/metaGet Collection Meta Data.
/api/v1/nft/collection/newCreate New Collection.
/api/v1/nft/collections/createdGet All Created Collections.
/api/v1/nft/collection/updateUpdate Collection Meta-Data.
/api/v1/nft/tokens/allGet All NFTs.
/api/v1/nft/tokens/createdGet All Created NFTs.
/api/v1/nft/tokens/ownedGet All Owned NFTs.
/api/v1/nft/tokens/soldGet All Sold NFTs.
/api/v1/nft/tokens/metaGet NFT Meta Data.
/api/v1/nft/tokens/historyGet NFT Lifecycle History.
/api/v1/nft/tokens/newCreate New NFT.
/api/v1/nft/tokens/publishPublish / Unpublish an NFT.
/api/v1/nft/tokens/updateUpdate NFT Meta-Data.
/api/v1/nft/tags/createCreate NFT Tag.
/api/v1/nft/tags/allocateAllocate NFT Tag to NFT Item.
/api/v1/nft/tags/allGet Created NFT Tags.
/api/v1/nft/tokens/make-offerMake Bid for NFT.
/api/v1/nft/tokens/accept-offerAccept Bid/Sell NFT.
/api/v1/nft/tokens/buy-nftInstant-Buy NFT.
/api/v1/nft/creator/updateUpdate Creator Profile Data.
/api/v1/nft/creator/profileGet NFT Creator Profile Data.
/api/v1/nft/creator/collectionsGet NFT Collections of Creator.
General Data
5 endpoints · Platform integration
/api/v1/general/infoThis Endpoint allows you to check the API connection and ensure that the system is up and running.
/api/v1/general/countriesThis end-point returns the information for every country, including their individual support for certain functions and features:
/api/v1/general/us_statesThis end-point returns the information for every State of the United States of America.
/api/v1/general/currenciesThis end-point returns all currency data as follows as a dictionary/hash-map:
/api/v1/general/currencies_historicalThis end-point returns all currency data as follows as a dictionary/hash-map:
Notifications
4 endpoints · Platform integration
/api/v1/notifications/allThis Endpoint allows you to check the API connection and ensure that the system is up and running.
/api/v1/notifications/unreadThis Endpoint allows you to check the API connection and ensure that the system is up and running.
/api/v1/notifications/markThis Endpoint allows you to check the API connection and ensure that the system is up and running.
/api/v1/notifications/pushThis Endpoint allows you to check the API connection and ensure that the system is up and running.
Referral System
3 endpoints · Partner growth
/api/v1/network/refkeyThis Endpoint returns the Referral Key of the user, which can be used to generate links (via emailing, etc.) or to register other users in the AUTH: Register a User Endpoint.
/api/v1/networkThis Endpoint provides information about the usage of the user's referral link, including some information about the referred users and the underlying hierarchy thereof.
/api/v1/network/inviteInvite/Refer a new User.
KYC / AML Functions
5 endpoints · Compliance operations · User onboarding
/kyc/aristaflow/widgetThis Endpoint allows a mobile app or iframe to load the AristaFlow KYC System Widget by submitting the bearer token of the logged in user.
/api/v1/kycaml/personaldataThis Endpoint allows for initial basic information to be uploaded, including the PEP (politically exposed person) status.
/api/v1/kycaml/addressdataThis Endpoint allows for Address data to be uploaded.
/api/v1/kycaml/identificationdataIn this Endpoint, the ID type must be defined, and the front and back of the identification document must be uploaded.
/api/v1/kycaml/selfiedataIn this Endpoint, selfie data can be either uploaded as an image or a video.
Admin Functions
6 endpoints · White-label platforms · Enterprise operations
/api/v1/admin/user_listThis Endpoint returns a list of all Users (of all kinds) that have been allocated to the Tenant to which the calling user's Authentication is a supervisor or admin of.
/api/v1/admin/transaction_listThis Endpoint returns a list of all Transactions (of all kinds) that have been made to any white-label user.
/api/v1/admin/pending_kycsThis Endpoint returns a list of all pending KYC submissions) that have been made to any white-label user.
/api/v1/admin/approved_kycsThis Endpoint returns a list of all pending KYC submissions) that have been made to any white-label user.
/api/v1/admin/kyc_status_updateThis Endpoint returns a list of all pending KYC submissions) that have been made to any white-label user.
/api/v1/admin/set_custom_meta_dataThis Endpoint allows for custom whitelabel data to be uploaded in the JSON format.
Quantum Entropy
2 endpoints · Security infrastructure
Quantum Storage
10 endpoints · Protected data
/api/v1/quantum/storage/uploadUpload File to Data Vault.
/api/v1/quantum/storage/metadataRequest File Meta Data.
/api/v1/quantum/storage/downloadCreate File Download Link from DataVault.
/api/v1/quantum/storage/newfolderCreate New Folder.
/api/v1/quantum/storage/renameRename Items in DataVault.
/api/v1/quantum/storage/recycleRecycle File in DataVault.
/api/v1/quantum/storage/restoreRestore File from Recycle Bin.
/api/v1/quantum/storage/deleteDelete File From Data Vault.
/api/v1/quantum/storage/favoriteToggle Favorites for File or Folder.
/api/v1/quantum/storage/datatreeGenerate Data Structure Tree.
Data Sync Functions
11 endpoints · Enterprise integration · White-label platforms
/api/v1/sync/stats/generalThis Endpoint returns a list of all Transactions (of all kinds) that have been made to any white-label user.
/api/v1/sync/profiles/fullThis Endpoint returns a list of all Transactions (of all kinds) that have been made to any white-label user.
/api/v1/sync/profiles/pending_kycThis Endpoint returns all profiles with a pending KYC under the whitelabel tenant.
/api/v1/sync/profiles/recentThis Endpoint returns a list of all Transactions (of all kinds) that have been made to any white-label user.
/api/v1/sync/vaults/fullThis Endpoint returns a list of all Transactions (of all kinds) that have been made to any white-label user.
/api/v1/sync/vaults/all_pubkeysThis Endpoint returns a list of all Transactions (of all kinds) that have been made to any white-label user.
/api/v1/sync/ledger/fullThis Endpoint returns a list of all Transactions (of all kinds) that have been made to any white-label user.
/api/v1/sync/transfers/fullThis Endpoint returns a list of all Transactions (of all kinds) that have been made to any white-label user.
/api/v1/sync/swaps/fullThis Endpoint returns a list of all Transactions (of all kinds) that have been made to any white-label user.
/api/v1/sync/reconciliation/fullThis Endpoint returns a list of all Transactions (of all kinds) that have been made to any white-label user.
/api/v1/sync/balance/profilesThis Endpoint returns a list of all Transactions (of all kinds) that have been made to any white-label user.
DataStreams Functions
7 endpoints · Evidence automation · Real-time data
/api/v1/streams/all_streamsList all DataStreams.
/api/v1/streams/createCreate new Data Stream.
/api/v1/streams/subscriber_whitelistWhitelist Vault for Private DataStream.
/api/v1/streams/subscriber_blacklistBlacklist Vault from Private DataStream.
/api/v1/streams/publisher_whitelistWhitelist Publisher Permissions for DataStream.
/api/v1/streams/publisher_blacklistBlacklist Publisher Permissions for DataStream.
/api/v1/streams/toggle_activityToggle Active State of DataStream.
Blockchain Explorer Functions
17 endpoints · Public verification · Audit and reporting
/explorer/searchAllows for searches of various fields around the explorer functinality.
/explorer/summaryReturns a high-level summary of chain state for explorer views.
/explorer/transactionsReturns the full list of blockchain transactions available through the explorer endpoint.
/explorer/transactions/TRANSACTION_HASHGet Transaction Details.
/explorer/vaultsGet All Vaults.
/explorer/vaults/b00dc220da8f480d86cdc+15555550123Get Vault Details.
/explorer/vaults/b00dc220da8f480d86cdc+15555550123/historyGet Vault History.
/explorer/liquidity_poolsGet Liquidity Pools.
/explorer/liquidity_pools/eventsGet Liquidity Pool Events.
/explorer/ordersGet Orders.
/explorer/orders/0695ca418af345d58f77498c8b8ce1e0Get Order Details.
/explorer/tradesGet Trades.
/explorer/trades/274d57e0823a4bb2bde937983e0450d8Get Trade Details.
/explorer/currenciesGet All Currencies.
/explorer/currencies/fiatGet Fiat Currencies.
/explorer/currencies/cryptoGet Crypto Currencies.
/explorer/datastreamsGet All DataStreams.