Jump to Content
Documentation
API Reference
SDK
User Guides
v3.38
v3.40
v3.42
v3.44
v3.46
v3.48
v3.50
v3.52
v3.54
v3.56
Protect & Capital
Prime
User Guides
API Reference
Protect & Capital
Prime
User Guides
v3.56
Documentation
API Reference
SDK
User Guides
Modifying configurations
JUMP TO
Introduction
API Structure and Concepts
Blockchains, Network & Currency
Pagination
API: Getting Started
Authentication
Introduction
Bearer Authentication
Short-Lived Access Tokens
HMAC Based Authentication
Wallets & Addresses (Internal Addresses)
Whitelisted Addresses (External Addresses)
Transactions
Signing for approval
Price Management
Staking
Ethereum
Solana
Tokenization & Issuance
Mint & Burn
Ethereum (EVM Based Tokens)
Solana
Taurus Network
Address & Asset Sharing
Pledging & Collateral
Webhooks & Notifications
Creating a configuration
Receiving calls
Webhooks Types
Address Balance Update
Currency Status Update
External Transaction Received
Internal Transaction Received
Request Status Update
Call Signature
Exchange Accounts
Helpers and monitoring
Changes
Wallets and Addresses
Currencies
List currencies
get
Get base currency
get
Get currency
get
Blockchain
Get blockchain entities
get
Use /api/rest/v1/blockchains instead
get
Balances
Get the total balances for the tenant, for each asset
get
Get the total balances for the tenant, for each nft collection
get
Contract whitelisting
List whitelisted contracts
get
Create whitelisted contracts
post
Approve a whitelisted contract
post
Delete a whitelisted contract
post
List whitelisted contracts for approval
get
Reject a whitelisted contract
post
Get a whitelisted contract
get
Update whitelisted contracts
put
Create attributes
post
Get an attribute
get
Delete an attribute
del
Address whitelisting
List whitelisted addresses
get
Create a whitelisted address
post
Approve a whitelisted address
post
Delete a whitelisted address
post
Export whitelisted addresses
get
List whitelisted addresses for approval
get
Reject a whitelisted address
post
Get a whitelisted address
get
Create attributes
post
List attributes
get
Delete an attribute
del
Tags
List tags
get
Create tag
post
Delete tag by id
del
Reservations
List reserved funds
get
Get a reservation
get
Get the UTXO associated to the reservation
get
Wallets
Recomputes wallets' balances
get
Trigger recomputation of existential balances
get
List wallets
get
Create a wallet
post
List wallets
get
Get a wallet
get
List wallet's balances history
get
Get the list of tokens for a wallet
get
Create attributes
post
Delete an attribute
del
List wallets
get
Get a wallet
get
Addresses
List addresses
get
Create an address
post
Create a batch of addresses
post
Export addresses
get
List light addresses
get
Recompute addresses signatures
post
List addresses's status
get
Create attributes
post
Delete an attribute
del
Calculate a BTC specific signature of a message
get
Sign a message with a Canton address key
get
Calculate an ETH specific signature of a message
get
Get an address
get
List address' balances history
get
Export address' balances history
get
Get the proof of reserve of an address
get
Get the list of tokens for an address
get
List UTXOs of an address
get
Get the balance of the address
get
Get the daily transactions of the address
get
Get the proof of reserve of a list of addresses
get
TRANSFERS AND STAKING
Requests: Mina
Create a Mina delegation request
post
Create a Mina undelegation request
post
Requests: ICP
Create an ICP follow request
post
Create an ICP set dissolve delay request
post
Create an ICP start dissolving request
post
Create an ICP transfer to stake request
post
Requests: Hedera
Create a hedera associate request
post
Create a hedera dissociate request
post
Create a hedera staking request
post
Create a hedera unstaking request
post
Requests: FTM
Create a claim rewards request
post
Create a delegate request
post
Create an undelegate request
post
Create a withdrawal request
post
Requests: DOT
Create a DOT bond request
post
Create a DOT bond extra request
post
Create a DOT chill request
post
Create a DOT nominate request
post
Create a DOT unbond request
post
Create a DOT withdraw unbonded request
post
Requests: Cosmos
Create a delegate request
post
Create a generic cosmos request
post
Create an undelegate request
post
Create a withdrawal request
post
Requests: ALGO
Create an ASA opt in request
post
Requests: ADA
Create a delegate request
post
Create an undelegate request
post
Create an vote delegation request
post
Create a withdrawal request
post
Requests
Force kill a request bundle
post
Force kill a request
post
Create request attributes
post
Get a request attribute
get
List requests
get
Approve a request
post
List asynchronous approvals
get
Get auto-transfer event handlers
get
Get auto-transfer event handler by id
get
Trigger an auto-transfer
post
Create an outgoing request bundle
post
Create an outgoing request bundle (using addresses)
post
List request bundles
get
List request bundles for approval
get
Get a request bundle
get
Create a fiat provider deposit request
post
Create a fiat provider transfer request
post
Create a fiat provider withdrawal request
post
List requests for approval
get
Create an incoming request
post
Create an outgoing request
post
Create an outgoing cancel request
post
Create an ETH consolidation request
post
Create a simple outgoing request (using addresses)
post
Create an outgoing request with selected UTXOs
post
Reject a request
post
Stake ETH
post
Create an ETH unstake request
post
Get a request
get
Update a request status
put
List asynchronous approvals
get
List requests
get
List requests for approval
get
Create a fiat provider convert request
post
Fee
List fees
get
List native currency fees
get
Earn
Claim earning rewards
post
Create an earning deposit
post
List rewards
get
Withdraw an earning deposit
post
Requests: NEAR
Create a NEAR deposit_and_stake request
post
Create a NEAR unstake request
post
Create a NEAR withdraw request
post
Requests: SOL
Create a SOL merge request
post
Create a SOL delegate request
post
Create a SOL token creation request
post
Create a SOL token burn request
post
Create a SOL token mint request
post
Create a SOL deactivate stake request
post
Create a SOL withdraw request
post
Requests: XLM
Create an XLM Manage Buy Offer request
post
Create an XLM change trust request
post
Create an XLM claim claimable balance request
post
Create an XLM clawback request
post
Create an XLM clawback claimable balance request
post
Create an XLM create account request
post
Create an XLM create claimable balance request
post
Create an XLM liquidity pool deposit request
post
Create an XLM CAP-15 fee-bump request
post
Create an XLM manage data request
post
Create an XLM Payment request for a new asset on the ledger
post
Create an XLM path payment strict receive request
post
Create an XLM path payment strict send request
post
Create an XLM CAP-33 sponsored-reserve request
post
Create an XLM revoke sponsorship request
post
Create an XLM Manage Sell Offer request or Create Passive Sell Offer request
post
Create an XLM Set Options request
post
Create an XLM set trustline flags request
post
Create an XLM liquidity pool Withdraw request
post
Requests: XRP
Create an XRP trust set request
post
Requests: XTZ
Create a delegate request
post
Create a stake request
post
Create an undelegate request
post
Create an unstake request
post
Get XTZ baker
get
Transactions
List transactions
get
Export transactions
get
Export the travel rule data of a transaction
get
Staking
Get ADA stake pool info
get
Get ETH validators info
get
Get FTM validator info
get
Get ICP neuron info
get
Get NEAR validator info
get
Get stake accounts
get
Get XTZ received staking rewards
get
Earning
TOKEN ISSUANCE AND ASSET SERVICING
Requests: Contracts
Create a call contract request
post
Create a deploy contract request
post
Token metadata
Use '/api/rest/v1/evm/{network}/erc/contract/{contract}/token/{token}/metadata' instead
get
Get CryptoPunk metadata
get
Get ERC token metadata
get
Get FA token metadata
get
Assets
Get the balance, at address level, for a specific asset
post
Get the balance, at wallet level, for a specific asset
post
AssetV2
List assets (deprecated, Canton-only)
get
Create asset
post
List assets
post
Set the KYC status of an address for an asset
post
List addresses for an asset
post
Burn tokens
post
Mint tokens
post
List operations for an asset
get
Get a single asset operation
get
Update asset
post
Get an asset
get
Workflows
List workflows
get
Get a workflow
get
Shareholders
List shareholders
get
Create a shareholder
post
Get a shareholder
get
Delete a shareholder
del
Update a shareholder
put
Tokenize a shareholder
post
Notifications
List notifications
get
Count notifications by status
get
Mark a notification as read
post
Issuers
Create an issuer
post
List issuers info
get
Update issuer status
put
Get an issuer
get
Delete an issuer
del
Update an issuer
put
Investors: whitelist
List investors whitelists
get
Create an investors whitelist
post
Get an investors whitelist
get
Delete an investors whitelist
del
Update an investors whitelist
put
List addresses of an investors whitelist
get
Issue an investors whitelist
post
Update investors of a whitelist
post
Investors
Create an investor
post
Import an investor
post
List investors info
get
Get an investor
get
Delete an investor
del
Update an investor
put
Restrictions
Create a rule engine
post
Update a rule engine
put
Add rules
post
Activate a rule
post
Delete a transfer rule
del
Update a transfer rule
put
List transfer rules
post
DigitalAssets
Create a digital asset
post
Import a digital asset
post
List digital asset info
get
List digital assets related to a whitelist
get
Get a digital asset field
get
Update a digital asset field
put
Get a digital asset
get
Delete a digital asset
del
Update a digital asset
put
List digital assets owners and balances
get
List digital asset fields
get
Create digital asset fields
post
Update a digitalAsset fields
put
List digital asset holders
get
Issue a digital asset
post
NFT mint call
post
NFT mint batch call
post
List NFTs
post
List digital asset restrictions
get
Link a digital asset to a whitelist
post
Contracts: XTZ template
Parse XTZ contract arguments
post
List storage parameters
get
Contracts: template
Create a contract template
post
Update a contract template
put
List contract templates info
get
Get a contract template
get
Delete a contract template
del
Contracts: XTZ instance
Deploy an XTZ contract instance
post
List XTZ entry points
get
Call view (read-only) on an XTZ contract
post
List XTZ events
get
Send a blockchain transaction to an XTZ contract
post
Contracts: instance
Import a contract instance
post
List contract instances
get
List contract transactions
get
Get a contract instance
get
Contracts: EVM instance
Deploy an EVM contract instance
post
Execute an EVM call
post
List EVM events
get
Send an EVM transaction
post
Upgrade an EVM proxy
post
Attachments
Create attachment
post
Get an attachment
get
Delete an attachment
del
Envelopes
List envelopes
get
Create an envelope
post
List docusign attachment
get
Get an envelope
get
List signers of an envelope
get
Taurus Network
Taurus Network - Shared address/asset
List shared addresses
get
Share an address
post
Unshare an address
post
List shared assets
get
Share an asset
post
Unshare an asset
post
Taurus Network - Participant
Create an attribute for a participant
post
Delete an attribute for a participant
del
List participants
get
Get my participant
get
Get participant by ID
get
Taurus Network - Settlement
List settlements
get
Create settlement
post
List settlements for approval
get
Get settlement
get
Cancel settlement
post
Replace settlement
post
Taurus Network - Pledge
List pledges
get
Create pledge
post
List pledge actions
get
Approve a pledge action
post
List pledge actions for approval
get
Reject a pledge action
post
List pledges withdrawals
get
Get pledge
get
Update pledge
put
Add pledge collateral
post
Initiate withdraw pledge
post
Reject pledge
post
Unpledge
post
Withdraw pledge
post
Taurus Network - Lending
List lending agreement
get
Create lending agreement
post
List lending agreements for approval
get
Get lending agreement
get
List lending agreement attachments
get
Create lending agreement attachment
post
Cancel lending agreement
post
Pay remaining interest
post
External lending agreement transition
post
Repay lending agreement
post
Update lending agreement
post
List lending offers
get
Delete my lending offers
del
Create lending offer
post
Get lending offer
get
Delete lending offer
del
Update lending offer
post
IDENTITY AND ACCESS MANAGEMENT
Restricted visibility groups
List restricted visibility groups
get
List users in a restricted visibility group
get
Authentication: HMAC
Validate request
post
Users
Reveal user API key
post
List users
get
Get my own user
get
Create user attribute
post
Delete an attribute from current user
del
Update my password
put
Renew token
post
Enable TOTP
post
Reset TOTP
post
Get user by id
get
Create an user attribute
post
User Device
Create a pairing request (Step 1)
post
Approves a user's device pairing request (Step 3)
post
Starts a user's device pairing request (Step 2)
post
Get the status of a user's device pairing request
get
SCIM
SCIM Get groups
get
SCIM Create a group
post
SCIM Get a group
get
SCIM Delete a user
del
SCIM Patch a user
patch
Get SCIM service provider config
get
SCIM Get users
get
SCIM Create a user
post
SCIM Put a user
put
SCIM Get a user
get
SCIM Delete a user
del
SCIM Patch a user
patch
Multi-Factor Signature
Get the associated entities information
get
Approve the underlying entities using a multifactor approach
post
Reject the underlying entities
post
Creates a multifactor signature
post
Groups
List groups
get
Authentication
Start a login
post
Get an authentication token
post
List security domains
get
Log out
post
Refresh authentication tokens
post
Get an authentication token
post
Authentication: SAML
Check assertion
post
Initiate login
post
Get authentication token
post
Upgrade SAML session to v2 tokens
post
Authentication: OIDC
Initiate login
post
Get authentication token
post
Get v2 tokens from OIDC login
post
Policy Engine
Governance rules
List governance rules
get
List governance rules history
get
List governance rules proposal
get
Update governance rules proposal
put
Approve governance rules proposal
post
Reject governance rules proposal
post
List public keys
get
List governance rules
get
SYSTEM ADMINISTRATION
Config
Get some configuration of the tenant
get
Business rules
List business rules
get
Enable/disable requests
put
List business rules
get
Steward
Initialize a tenant
post
List the API keys
get
Create an API key
post
Delete the API key
del
Initialize the ETH contract support
post
Setup secondary commitment
post
Initialize the XTZ contract support
post
Statistics
List currencies statistics
post
List currency's statistics history
post
Get count of activities to be approved
get
Get portfolio statistics
get
Get portfolio statistics history
get
Get portfolio statistics history export
get
List tags statistics
get
List assets statistics for a certain tag
get
Get Taurus-NETWORK pledges statistics
get
Fee payers
List fee payers
get
Get a checksum
post
Initiate fee payer
post
Get a fee payer
get
Prices
List prices
get
Update a price
put
Convert an amount to other currencies
get
Export prices history
get
List prices history
get
Get a price by id
get
List prices
post
Jobs
Get jobs
get
Get job
get
Get job status
get
Health
List health checks
get
List health checks
head
List all health checks
get
List all health checks
head
List health checks in a group
get
List health checks in a group
head
Get a health check
get
Get a health check
head
Get the component health status
get
List all health statuses
get
Get the global health status
get
List the health statuses of a group
get
List all health statuses of a group
get
Changes
List changes
get
Create a change
post
Approve changes
post
List changes for approval
get
Reject changes
post
Get change by ID
get
Approve a change
post
Reject a change
post
Audit
Get audit trails
get
Export audit trails
get
Actions
List actions
get
Get an action
get
3rd party integrations
Scores
Refresh address score
post
Refresh WLA score
post
Exchange
List exchange accounts
get
Export exchange accounts
get
Get an exchange account
get
Get the withdrawal fees
get
List exchanges
get
Fiat
List fiat providers
get
List fiat providers accounts
get
Get fiat provider account
get
List fiat providers counterparty accounts
get
Get fiat provider counterparty account
get
List fiat providers operations
get
Get fiat provider operation
get
Exchange
Withdraw & Deposit
AIRGAP COLD HSM
AirGap
Import signed requests from the cold HSM.
post
Export HSM ready requests for cold HSM.
post
Webhooks
Get webhook calls
get
Webhooks
Get webhooks
get
Create webhook
post
Delete a webhook
del
Update a webhook's status
patch
Modifying configurations
Updated 13 days ago
API Structure and Concepts
Did this page help you?
Yes
No
Updated 13 days ago
API Structure and Concepts
Did this page help you?
Yes
No
