API Reference
Clients
A client is one of your own customers or users. You register them with the id you use in your system (called externalId in responses), and RoxCustody keeps their funds separate from everyone else's. Clients exist only in API vaults (segregated or consolidated crypto vaults, and fiat vaults).
Crypto clients: creating a client starts the creation of their wallets, one per blockchain network enabled in the vault, in the background. Fetch them with the Wallets endpoints, or subscribe to the sync_client_wallets webhook to know when they are ready.
Fiat clients: created in fiat vaults. They need a legal name, and an IBAN if you want to refund their deposits.
Client ids must be unique per vault. Creating a client whose id already exists returns 422 with code E03401 and lists the existing clients.
Endpoints
POSTCreate New ClientRegisters one of your customers as a client of this crypto vault. Wallet creation for every enabled network starts in the background. Only available in crypto API vaults.POSTCreate ClientsRegisters several clients of this crypto vault in one call, by id only. Use Create New Client if you also want to store a name, email or mobile number. If any id already exists, nothing is created.POSTCreate Fiat ClientRegisters a client in a fiat vault. Provide the IBAN if you may need to refund the client's deposits: refunds go back to this IBAN. Only available in fiat vaults.POSTBulk Create Fiat ClientsRegisters several fiat clients in one call. Each item has the same fields as Create Fiat Client. If any id already exists, nothing is created.
Was this page helpful?