Object Types

The Fordefi REST API provides endpoints for accessing the following core objects.

Organization

Your account (or workspace) on Fordefi that contains all your vaults, users, policies, and more. There can be one or more user in an organization. A user can be a member in more than one organization. An organization contains a user directory and a set of managed Vaults. Learn more

Vaults

The basic unit to manage funds. A vault has a single public address but is multi-chain, meaning you can use it across all chains that are compatible with the address and are supported by Fordefi. For example, a single EVM vault can be used on all the EVM chains supported by Fordefi. Learn more.

Vault Group

This resource collection represents a vault group. Learn more.

Assets

A native currency or a token. A vault can have multiple assets across multiple chains, all under the same vault address. Learn more.

Transactions

A transaction is any object that can be signed cryptographically (with a private key).

In general, it can be one of the following types:

  • EVM Transaction: a native currency transfer or a smart contract call on an EVM-based chain.
  • EVM Message: in which a message is signed for off-chain use on an EVM-based chain.
  • EVM Revoke Allowances: in which you create a transaction request for revoking an ERC-20 allowance.
  • Solana Transaction: a native currency transfer on a Solana-based chain.
  • Cosmos Raw Transaction: a general Cosmos transaction can be used for any transaction on any of the supported Cosmos chains.
  • Black Box Signature: in which a payload is signed for use, external to the Fordefi platform.

Learn more

Users

This resource collection represents a user. There are different types of users in the Fordefi platform:

  • Person: a human user of the platform.
  • API user: an API client key that is trying to interact with the platform.
  • API Signer: used to auto-sign transactions. See Sign Transactions with the API Signer.

In addition, there are three possible user roles, which define the permissions that the user is given: admins, traders, or viewers.

Learn more

User Group

This resource collection represents a user group.

Learn more

End Users

This resource collection represents end users.

End users are the users of a third-party app that embeds cryptographic technology provided by Fordefi. Each end user's mobile device can have a unique key-share, where Fordefi holds the matching key-share.

Learn more

Authorization Tokens

This resource collection represents authorization tokens.

These tokens allow end users to authenticate with Fordefi. Each end user can have a maximum of ten active authorization tokens at any time. Each token is valid for 24 hours only.

Learn more

Keysets

This resource collection represents keysets.

A keyset is a high-level object that includes the three different key types: EdDSA, ECDSA, and ECDSA-Stark.

Learn more

Blockchains

This resource represents a blockchain. Learn more.

Webhooks

This resource collection represents webhooks.

Webhooks are used to notify your application of events that have occurred in the Fordefi platform. Learn more.

Address Book

Address Book is an object that represents a contact (saved blockchain address and its alias) in the platform. The Address Book object can either be queried directly or returned as part of a transaction. Learn more.

List Contacts

Get a list of all contacts in an organization. Learn more.