Fordefi API (0.2.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Production
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:

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.

Operations

Authorization Tokens

These endpoints allow you to manage end-user authorization tokens used for Fordefi's WaaS solution.

Authorization tokens allow end users to authenticate with Fordefi. Each end user can have a maximum of ten active authorization tokens at any time.

More information on authenticating end users is provided in the WaaS developer guide.

Operations

Blockchains

These endpoints allow you to get information about blockchains supported by Fordefi.

Operations

Webhooks

These endpoints allow you to manually trigger your pre-configured webhooks.

Use Webhooks describes how to configure webhooks, validate them, and resend them.

Operations

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.

Operations

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
Consult the developer guide for more information on creating, monitoring, and simulating tranasctions.
Operations

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.

Operations

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).

Operations

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.

Operations

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.

Operations

End Users

These endpoints allow you to manage WaaS end-users.

End users correspond to users of the platform who has integrated the Fordefi WaaS solution. For example, in the case of a retail platform, these would be the retail consumers of the platform.

Operations

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.

Operations

Exports

These endpoints allow you to manage asynchronous actions such as data exports.

Operations

Organizations

Operations

Import Keys

Request

Imports keys for an organization.

Bodyapplication/jsonrequired
typestringrequired
Discriminator
Value "fireblocks"
backup_zip_contentstringrequired

The base64 encoded content of the Fireblocks backup zip file.

Example: "SGVsbG8="
rsa_pemstringrequired

The base64 encoded RSA private key in PEM format.

Example: "SGVsbG8="
rsa_pem_passwordstring

The password for RSA private key.

curl -i -X POST \
  https://api.fordefi.com/api/v1/organizations/import-keys \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "fireblocks",
    "backup_zip_content": "SGVsbG8=",
    "rsa_pem": "SGVsbG8=",
    "rsa_pem_password": "string"
  }'

Responses

Successful Response

Response
No content

Complete Import Keys

Request

Completes the import keys process for an organization.

Bodyapplication/jsonrequired
encrypted_share_ecdsastring

The encrypted share for the organization's ECDSA key.

Example: "SGVsbG8="
encrypted_share_eddsastring

The encrypted share for the organization's EdDSA key.

Example: "SGVsbG8="
encrypted_share_ecdsa_starkstring

The encrypted share for the organization's ECDSA-Stark key.

Example: "SGVsbG8="
encrypted_share_schnorr_secp256k1string

The encrypted share for the organization's Schnorr key.

Example: "SGVsbG8="
curl -i -X POST \
  https://api.fordefi.com/api/v1/organizations/complete-import-keys \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "encrypted_share_ecdsa": "SGVsbG8=",
    "encrypted_share_eddsa": "SGVsbG8=",
    "encrypted_share_ecdsa_stark": "SGVsbG8=",
    "encrypted_share_schnorr_secp256k1": "SGVsbG8="
  }'

Responses

Successful Response

Response
No content

Abort Import Keys

Request

Aborts the import keys process for an organization.

curl -i -X POST \
  https://api.fordefi.com/api/v1/organizations/abort-import-keys \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response
No content

Get Import Keys Status

Request

Gets the import keys status for an organization.

curl -i -X GET \
  https://api.fordefi.com/api/v1/organizations/import-keys-status \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
statestringrequired

The state of the import keys request.

Enum"not_started""in_progress""completed"
imported_ecdsabooleanrequired

Whether an ECDSA key was imported.

imported_eddsabooleanrequired

Whether an EdDSA key was imported.

imported_ecdsa_starkbooleanrequired

Whether an ECDSA-Stark key was imported.

imported_schnorr_secp256k1booleanrequired

Whether a Schnorr key was imported.

Response
application/json
{
  "state": "not_started",
  "imported_ecdsa": true,
  "imported_eddsa": true,
  "imported_ecdsa_stark": true,
  "imported_schnorr_secp256k1": true
}