Fordefi API (0.2.0)
https://api.fordefi.com/
Users
These endpoints allow you to get information about users in your Fordefi organization.
There are several types of users in the Fordefi platform:
- Person: A human user of the platform.
- API User, also commonly known as a service account. See Create an API user.
- API Signer: Used to auto-sign transactions. See Automate Signing with API Signer.
Users can have one of three possible roles, which define the permissions that the user is given:
- Admin: A user with high privileges in the organization. Only admins have permission to manage the policy, set up the backup, manage the address book, and add or remove users in the organization. Only a person can have an admin role.
- Trader: A user who can create vaults and transactions.
- Viewer: A user who has full view of the organization's users, addresses, and policies, as well as of the vaults and transactions, but does not have permissions to create or modify them.
The Users API is currently read-only. To add/remove users, visit the Fordefi web console.
Webhooks
These endpoints allow you to manually trigger your pre-configured webhooks.
Use Webhooks describes how to configure webhooks, validate them, and resend them.
- Production
https://api.fordefi.com/api/v1/webhooks/trigger/transaction/{id}
- curl
- Python
- JavaScript
- Go
- C#
- Payload
curl -i -X POST \
'https://api.fordefi.com/api/v1/webhooks/trigger/transaction/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
Address Book
These endpoints allow you to list the contacts in your address book.
To add/remove contacts, visit the Fordefi web console. See the user guide for more info.
Transactions
These endpoints allow you to manage transactions on the Fordefi platform.
A transaction represents an operation that can be one of the following:
- An on-chain action that modifies blockchain state
- An off-chain cryptographically signed message or data
Batch Transactions
These endpoints allow you to manage batch transactions on the Fordefi platform.
Batch transactions are currently supported only on Solana, for the purpose of supporting the signAllTransactions
flow used by certain Solana DApps. Batch transactions undergo policy evaluation as a whole: the policy is applied to a “virtual transaction” whose list of instructions is the union of the instructions of the individual transactions in the batch, and whose balance changes are the aggregation of balance changes of the individual transactions.
Vaults
These endpoints allow you to manage vaults.
A vault is the basic unit to manage funds. Each vault supports a single "chain family", such as EVM, Bitcoin, Solana, Cosmos, etc., determined by the vault's type. A vault supports all the chains within the chain family (e.g., an EVM vault supports all EVM chains).
Vault Groups
These endpoints allow you to view your vault groups.
Vault Groups are used to collectively manage policies and view permissions for a group of vaults.
The API is read-only. To manage vault groups, visit the Fordefi web console. See more info in the user guide.
Assets
These endpoints allow you to get information about the assets in your organization, including metadata, balances, and prices.
Fordefi supports native assets and fungible tokens on each of the supported blockchains, and on many chains also non-fungible tokens.
Assets are chain-specific, meaning that USDC on Ethereum is different from USDC on Polygon.
User Groups
These endpoints allow you to view your user groups.
User Groups are used to collectively manage policies and view permissions for a group of users.
The API is read-only. To manage user groups, visit the Fordefi web console. See more info in the user guide.