Skip to navigation
Welcome

Use Cases with API entry points

What you can do with the API, and the endpoints to start with.

Pick a category, then open a use case to see what it does, what to watch for, and which endpoints to use.

Platform

Access, approvals and notifications

Digital asset custody

Wallets, transfers, fees and balances

Tokenized assets and smart contracts

Issue tokens and call smart contracts

Digital currencies

Stablecoins and tokenized deposits

Staking and yield

Stake per blockchain and earn yield

Platform

The foundation for everything you build. Give people and systems secure access, enforce approvals that follow your governance, and get notified of every event.

Before you start

  • Your system uses the API through a technical user. Its API key has the same roles as that user, and no more.
  • Each call is authenticated with your API key, as described in the Authentication guide.

Guides: Authentication · Signing for approval · Webhooks & Notifications · Changes

Get a token, or sign each call with your API key.Note: A user manager can reveal an API key’s secret only once. A lost secret cannot be recovered. It can only be replaced by a new key.
Create and update users and groups from your identity provider.Note: Governance rules use groups. A group change can change who is allowed to approve.
Read users, set attributes, reset one-time codes and reveal a user’s API key.Note: Every user needs the base access role, tpuser. It is not added automatically.
Link an approver’s device so it can sign approvals.Note: Another Admin and one or more SuperAdmins must approve the new key.
Approvers scan a QR code in the web interface and approve on their phone.Note: A Taurus-SIGN device can only approve through this flow. It cannot use the regular approve endpoint.
Read groups and restricted visibility groups.Note: Restricted visibility groups apply filtering to all roles except SuperAdmin, SuperAdmin Readonly, Admin and Admin Readonly.
Read your governance rules and propose changes.Note: A governance change only takes effect after SuperAdmins sign it. The whole rule set is accepted or rejected at once.
Changes to users, groups and settings wait for a second Admin.
Approve requests from your own system, signing with a key you hold.Note: An Admin sets the public key and the approval group on the API user. Another Admin and one or more SuperAdmins must approve both.
Note: Changing its signing method needs a new public key and new approvals.
Receive webhooks for requests, transactions and balances.
Read your tenant configuration and business rules.

Digital asset custody

Secure custody for cryptocurrencies and tokens, for your clients or your own treasury. Create wallets, move funds and reconcile balances, with every transfer approved under your rules and signed in the HSM.

Before you start

  • The currency is enabled in your business rules. A token can only be enabled after its contract is whitelisted.
  • A governance rule covers the wallet and the currency. Without one, requests cannot be created.
  • Your API user has the roles it needs, such as request creator.

Guides: Wallets & Addresses · Whitelisted Addresses · Transactions · Price Management · Helpers and monitoring

Read the currencies and blockchains enabled in your tenant, and the base currency used to value them.
Whitelist a token so it can be enabled, held and transferred.Note: A token can only be enabled after it is whitelisted.
Note: On EVM blockchains and Tezos, a token is a smart contract. Whitelisting the token lets you hold and transfer it. Calling its functions, such as mint, also needs its contract address to be whitelisted.
Create wallets, then one address per client, purpose or transaction.Note: One wallet holds one currency, on one blockchain.
Approve an external address once, before any transfer to it.Note: Whitelisting has its own approval rule, separate from the transfer rules.
Note: Some destinations need a memo or tag. It is part of the whitelisted address.
Send from a wallet or an address, to a whitelisted address or to your own address.Note: A request with an externalRequestId that already exists is not created again. The API returns the original request instead.
Note: The source must hold the amount plus the fee. The fee is set after the last approval.
Approvers sign the request’s metadata hash, or reject it with a reason.Note: A request expires if no approval comes within the time limit between approvals.
Note: Approvers can approve up to 500 requests in one call.
Stop a request that is still waiting for approval or in the grace period.Note: It needs the request canceler role.
Note: The status field of the API reports a cancelled request as PERMANENT_FAILURE; the history of the request records CANCELED.
Group many transfers into one bundle.Note: On account-based blockchains like Ethereum, Taurus-PROTECT sets each transfer’s nonce only after approval, so a transfer that waits longer for approval does not hold back the others from the same address.
Read incoming transactions, and the tokens an address holds.Note: Deposits from any address are detected, whitelisted or not.
Note: A new deposit first counts in the unconfirmed balance. The confirmed balance updates once the blockchain confirms it.
Read fees and use a fee payer, so token addresses do not need their own coin.Note: Without a fee payer, a token transfer pays its fee in the blockchain’s coin, so the token address must hold some.
Note: Taking the fee out of the amount does not work for token transfers.
Pick the coins a Bitcoin-style transfer spends, instead of letting Taurus-PROTECT choose.
On Stellar, XRP Ledger, Algorand and Hedera, accept a token on an address before it can receive it.Note: A transfer to an address that has not opted in fails.
Note: On Stellar and Algorand, each token raises the minimum balance the address must keep.
Read your automation rules and trigger an automatic transfer.Note: Automated transfers still need the approvals your governance rules require.
Turn off all new requests and approvals in your tenant at once.Note: One Admin can do it, with no second approval.
Note: It does not recall a request that is already approved and past the grace period.
Read and update the prices used to value assets and check limits.Note: Amount limits are checked against these prices. If a price is wrong, a limit can block a valid transfer.

Tokenized assets and smart contracts

Issue, manage and service tokenized assets on one platform. Taurus-CAPITAL runs issuance. Taurus-PROTECT holds the keys and signs every operation.

Before you start

  • The blockchain decides how a token is created: a smart contract on Ethereum, Hyperledger Besu and other EVM blockchains or Tezos, or a native token on Stellar, Solana or Canton.
  • Every deployment, mint, burn and contract call is a request. It is approved and signed like a transfer.
  • Each contract call needs a governance rule for its contract type and function. Without one, the request fails.

Guides: Tokenization & Issuance · Ethereum (EVM Based Tokens) · Solana tokens

Create, update and remove the templates contracts are deployed from.Note: Genuine Taurus templates cannot be deleted. Deleting your own template cannot be undone.
Create, update and remove issuers in Taurus-CAPITAL.
Deploy a token contract from a template.
Shared endpoints
Blockchain-specific endpoints
Ethereum, Hyperledger Besu and other EVM blockchains
Tezos
Note: On EVM blockchains, Taurus-PROTECT requests the whitelisting of the contract address automatically after deployment.
Whitelist the smart contract’s address, with the address type Contract.Note: Taurus-PROTECT only calls whitelisted contracts. A call request takes the contract’s whitelisted address ID, not a raw address.
Create a token without a smart contract, on Stellar, Solana or Canton.Note: On Stellar, the authorization required and clawback flags only apply to trustlines opened after they are set.
Bring a token or contract that is already on chain into Taurus-CAPITAL.
Create or remove token supply.
Send tokens like any other transfer.
Shared endpoints
Note: The destination must be a whitelisted address.
Mark an address as verified or not for a token.
Blockchain-specific endpoints
Canton
See who holds the token and how much.Note: List digital asset holders returns only holders registered in Taurus-CAPITAL, from a scheduled refresh.
See the history and status of operations on the token, such as creation, mint, burn and KYC changes.
Blockchain-specific endpoints
Canton
Track issuance steps and read Taurus-CAPITAL notifications.
Keep the register of shareholders, and tokenize a shareholding.
Attach files to a Taurus-CAPITAL record.
Run a function on a whitelisted contract.
Shared endpoints
Blockchain-specific endpoints
Ethereum, Hyperledger Besu and other EVM blockchains
Tezos
Note: Each contract type and function needs its own governance rule.
Call a contract’s read-only functions, such as balanceOf, and list the events it emits and the transactions sent to it.
Shared endpoints
Blockchain-specific endpoints
Ethereum, Hyperledger Besu and other EVM blockchains
Tezos
Note: These calls only read data. They do not change anything on the blockchain.
Read a token’s name, symbol, decimals and contract address, and find the addresses that hold it, on any blockchain.
Shared endpoints
Blockchain-specific endpoints
Ethereum, Hyperledger Besu and other EVM blockchains
Tezos
Point a proxy contract to a new implementation. Its address stays the same.
Blockchain-specific endpoints
Ethereum, Hyperledger Besu and other EVM blockchains

Digital currencies

Launch and run stablecoins and tokenized deposits. Issue supply, decide who can hold it, and prove the reserves behind it.

Before you start

  • The token can be a smart contract on Ethereum, Hyperledger Besu and other EVM blockchains or Tezos, or a native token on Stellar, Solana or Canton, as described in Tokenized assets and smart contracts.

Guides: Tokenization & Issuance

Deploy the token contract on Ethereum, Hyperledger Besu and other EVM blockchains or Tezos, or create a native token on Stellar, Solana or Canton.Note: On Stellar, the authorization required and clawback flags only apply to trustlines opened after they are set.
Send units to holders. On Stellar, you can also send claimable balances that holders claim later.
Decide which addresses can hold the token, through the token contract, a KYC status or Stellar authorization.Note: With authorization required on Stellar, a holder cannot receive the token until the issuer authorizes their trustline.
Freeze a holder or take back tokens, where the token allows it.Note: On Stellar, clawback only works on trustlines created after it was turned on.
Remove units when holders redeem them.Note: On Stellar, tokens sent back to the issuing account are burned.
See who holds the token and how much.Note: List digital asset holders returns only holders registered in Taurus-CAPITAL, from a scheduled refresh.
See the history and status of operations on the token, such as creation, mint, burn and KYC changes.
Blockchain-specific endpoints
Canton
Produce a proof of reserve for one or more addresses.
Store a small key and value on a Stellar account.
Blockchain-specific endpoints
Stellar

Staking and yield

Put your assets to work without giving up custody. Stake with validators on supported blockchains, with every action approved under your rules and signed in the HSM. The Staking guide explains the flow.

Before you start

  • Each staking action is a request, approved under your governance rules and signed in the HSM.
  • Lock periods, rewards and minimum amounts differ by blockchain.
Read validator, stake pool, neuron or baker details before staking.
Delegate, undelegate, delegate votes and withdraw rewards.Note: Delegated ADA stays spendable. Rewards can only be withdrawn after the vote is delegated to a DRep.
Delegate, undelegate and withdraw rewards.Note: On Cosmos Hub, undelegated ATOM is locked for 21 days.
Stake, unstake and consolidate ETH validators.Note: Unstaked ETH does not come back at once. It waits in the network’s exit queue.
Note: The Ethereum staking guide walks through this flow step by step.
Delegate, undelegate, withdraw and claim rewards.Note: Rewards are claimed separately.
Stake and unstake HBAR.Note: Staked HBAR is not locked.
Stake into a neuron, set its dissolve delay and follow other neurons.Note: The dissolve delay decides how long the ICP stays locked.
Delegate and undelegate MINA.Note: Delegated MINA is not locked.
Deposit and stake, unstake and withdraw.Note: Unstaked NEAR can be withdrawn after four epochs, about one to two days.
Bond, nominate, unbond and withdraw.Note: Unbonded DOT is locked for 28 days before you can withdraw it.
Delegate, deactivate, withdraw and merge stake accounts.Note: Deactivation takes effect at the next epoch. Taurus-PROTECT then creates the withdraw request for you to approve.
Note: The Solana staking guide walks through this flow step by step.
Stake and unstake SUI with a validator.
• POST /requests/outgoing/sui/stake
• POST /requests/outgoing/sui/unstake
Note: Available from Taurus-PROTECT 3.58.2.
Note: The minimum stake is 1 SUI. Unstaking is instant, and rewards are paid out when you unstake.
Delegate and stake with a baker, and undo both.Note: Delegated XTZ stays spendable. Staked XTZ is locked.
Read stake accounts on Solana and Sui, and staking rewards on Tezos.
Deposit assets into supported ERC-4626 vaults, receive vault shares, monitor your position, and withdraw your assets. In the interface, this is Yield > Earn.Note: An ERC-4626 vault is a tokenized vault. It accepts an underlying asset and issues vault shares that represent your position. Supported vaults include Morpho vaults.
Note: The Earning guide walks through this flow step by step.