API Reference
Tokens
Create and run your own tokens. RoxCustody deploys the contract from a vault wallet, keeps the keys in custody and signs every later operation.
Templates. Create Token from Template deploys an audited contract template:
• erc20-v1 (standard ERC20): a fungible token. You choose its capabilities at creation (canMint, canBurn, canPause).
• erc721-v1 (standard ERC721): an NFT collection. Each NFT is minted later with its own metadata.
• erc3643-v1 (standard ERC3643): a permissioned security token (T-REX). Only addresses verified in your ERC-3643 identity registry can hold it, and agents can freeze, force-transfer and recover balances. It starts paused.
• title-fraction-v1 (standard ERC3643): an ERC-3643 token backed by a TradeTrust title. The title is handed to the token, then split into fractions; holding every fraction lets you redeem the title.
Create Token (v1) is the original flow for plain ERC-20 and Solana tokens.
Deployment is asynchronous: the token comes back with status PENDING and moves to DEPLOYED once the contract is on-chain (or REVERTED, INSUFFICIENT_GAS, ERROR or NONCE_TOO_LOW). Follow it with the token_created_with_asset webhook or Get Token by ID. Once deployed, the token is also an asset (assetId): wallets of that asset hold it.
Roles. The owner (OWNER role) is the wallet set at creation. ERC-3643 tokens also have agents (AGENT role), added and removed by the owner; the owner starts as the first agent. Get Token Roles lists who holds which role, and each operation says which role signs it.
Fees. The deployment fee is paid by the vault's gas station wallets, by payerPublicAddress when given, or from your corporate balance when the vault is gasless.
Tokens
GETGet Token Supported NetworksLists the networks where you can create tokens, with the token types each one supports. Use a network id as networkId when creating a token.POSTCreate Token from TemplateDeploys a token from a contract template. Pick the standard and the template, then give the template its config. The owner is an address (ownerAddress) or one of your clients (ownerClientId): give exactly one. Send JSON, or multipart/form-data to attach an image. The token comes back with status PENDING; it can be operated once DEPLOYED.GETGet Token by IDReturns one token of this vault: deployment status, contract address, template, config, network and the vault that created it.GETGet TokensLists this vault's tokens: fungible tokens (ERC-20, ERC-3643, Solana) and ERC-721 collections. Solana NFTs are listed by Get NFTs.GETGet Token RolesLists who holds the OWNER and AGENT roles of a token of this vault. To name an agent as the signer of an operation, pass a row's wallet.publicAddress as params.signerWalletAddress (or its walletId as params.signerWalletId). A role being added or removed shows PENDING_ADDITION or PENDING_REMOVAL until its transaction completes. Removed roles are left out unless you filter by status.PATCHUpdate Token MetadataAdds or changes metadata fields of a deployed token or NFT. The new fields are merged into the existing metadata file.
v1 (Solana)
POSTCreate Token (v1)Older flow, kept for Solana tokens. For EVM tokens, use Create Token from Template. Creates a plain token with the original flow: an ERC-20 on EVM networks (type 1, deployed from the erc20-v1 template) or a Solana token (type 2). Send multipart/form-data so you can attach an image. The owner is an address (ownerAddress) or one of your clients (ownerClientId): give exactly one. For ERC-3643, ERC-721 or to choose capabilities, use Create Token from Template.POSTMint Tokens (v1)Older flow, kept for Solana tokens. For every token created from a template, use Token Operations (Mint). Creates new units of a token you own. The tokens go to recipientAddress, to a client (clientId), or to the vault's master wallet (toMasterWallet): give exactly one. Returns the ID of the blockchain transaction, which you can follow like any transaction.POSTBurn Tokens (v1)Older flow, kept for Solana tokens. For every token created from a template, use Token Operations (Burn). Destroys units of a token you own, taken from recipientAddress, from a client's wallet (clientId), or from the vault's master wallet (fromMasterWallet): give exactly one. Returns the ID of the blockchain transaction.
Was this page helpful?