Skip to content

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

List Vaults

Request

Get a list of all vaults in an organization.

Security
bearerAuth
Query
sort_byArray of strings
Items Enum"created_at_asc""created_at_desc""name_asc""name_desc""vault_type_asc""vault_type_desc"
pageinteger>= 1

The page number to fetch.

Default 1
sizeinteger[ 0 .. 100 ]

The number of items per page.

Default 50
vault_idsArray of strings(uuid)

Vault IDs to filter on.

namesArray of strings

List of full names to filter on.

vault_typesArray of strings

Vault types to filter on.

Items Enum"aptos""black_box""cosmos""evm""solana""stacks""starknet""sui""ton""tron"
vault_statesArray of strings

Vault states to filter on.

Items Enum"active""archived"
keyset_idsArray of strings(uuid)

List of keyset IDs to filter on.

key_holder_idsArray of strings(uuid)

List of key holder IDs to filter on.

vault_group_idsArray of strings(uuid)

List of vault group IDs to filter on. Filter applies to current and pending vault groups.

exclude_vault_group_idsArray of strings(uuid)

List of vault group IDs to exclude.

origin_typestring

Origin type to filter on.

Enum"native""imported"
account_addressesArray of strings

List of account addresses to filter on.

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

Responses

Successful Response

Bodyapplication/json
totalintegerrequired
pageintegerrequired
sizeintegerrequired
vaultsArray of anyrequired
Response
application/json
{
  "total": 0,
  "page": 0,
  "size": 0,
  "vaults": [
    { … }
  ]
}

Create Vault

Request

Create a new vault.

Security
bearerAuth
Bodyapplication/jsonrequired
namestringnon-emptyrequired

The name of the vault.

end_user_idstring(uuid)

The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used.

vault_group_idstring(uuid)

The group to add this vault to. If not provided, the vault will be created in the Default vault group.

import_vaultobject

Additional information when creating a vault from an imported key. This field is relevant only for organizations using imported keys.

typestringrequired

Aptos vault type.

Discriminator
Value "aptos"
curl -i -X POST \
  https://api.fordefi.com/api/v1/vaults \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "end_user_id": "c5ac076e-1e7a-4f0d-9ad4-cae618230def",
    "vault_group_id": "948d8050-0dde-409f-985b-6d7b133fc9e8",
    "import_vault": {
      "derivation_path": "m/44/60/0/0/0",
      "key_id": "1e779c8a-6786-4c89-b7c3-a6666f5fd6b5"
    },
    "type": "aptos"
  }'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)required

The unique identifier of the object in the Fordefi platform.

created_atstring(date-time)required

The date and time when the object was created.

modified_atstring(date-time)required

The date and time when the object was last modified. Any change to any field of the resource is considered a modification.

metadataobject

Metadata in a form of map<str, bool | str | int | array[str]>.

namestringrequired

The name of the vault.

created_byPersonRef (object) or ApiUserRef (object) or ApiSignerRef (object) or EndUserRef (object) or SystemUserRef (object)required
One of:

Details of the vault creator.

vault_groupobjectrequired

The vault group this vault belongs to.

pending_vault_group_actionany

Details of pending vault movement to another vault group.

statestringrequired

State of the vault.

Enum"active""archived"
public_key_compressedstringrequired

The public key of the vault in its compressed form:

  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the SEC1 standard.
  • For EdDSA, the public key is represented as a 32-byte value, as defined by RFC 8032.

Example: "SGVsbG8="
derivation_infoobjectrequired

The derivation info of the vault.

key_holderobject

The user who owns the keyset of the vault. If not provided, the vault is owned by the organization.

origin_typestringrequired

The origin type of the vault.

Enum"native""imported"
typestringrequired

Aptos vault type.

Discriminator
Value "aptos"
addressstring= 66 characters^0[xX][a-fA-F0-9]+$required

The address of the vault on Aptos chain types.

Example: "0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "modified_at": "2019-08-24T14:15:22Z",
  "metadata": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "name": "string",
  "created_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user_type": "person",
    "name": "John Doe",
    "email": "string",
    "state": "active",
    "role": "admin"
  },
  "vault_group": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "vault_count": 0,
    "can_current_user_create_or_edit_vaults": true
  },
  "pending_vault_group_action": {
    "type": "add",
    "vault_group_id": "948d8050-0dde-409f-985b-6d7b133fc9e8",
    "vault_group_name": "string"
  },
  "state": "active",
  "public_key_compressed": "SGVsbG8=",
  "derivation_info": {
    "derivation_path": "m/44/60/0/0/0",
    "master_public_key": { … }
  },
  "key_holder": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user_type": "end_user",
    "external_id": "user|1234",
    "state": "active"
  },
  "origin_type": "native",
  "type": "aptos",
  "address": "0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a"
}

Export Vaults With Assets

Request

Get a CSV-format list of balances of all vaults and their assets.

Security
bearerAuth
Query
vaults_idsArray of strings(uuid)

Vault IDs to filter on.

vault_typesArray of strings

Vault types to filter on.

Items Enum"aptos""black_box""cosmos""evm""solana""stacks""starknet""sui""ton""tron"
curl -i -X GET \
  https://api.fordefi.com/api/v1/vaults/export \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Exported vaults in CSV format

Bodytext/csv
string
Response
No content

Get Vault

Request

Retrieve vault details.

Security
bearerAuth
Path
idstring(uuid)required

ID of the vault to retrieve.

curl -i -X GET \
  'https://api.fordefi.com/api/v1/vaults/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)required

The unique identifier of the object in the Fordefi platform.

created_atstring(date-time)required

The date and time when the object was created.

modified_atstring(date-time)required

The date and time when the object was last modified. Any change to any field of the resource is considered a modification.

metadataobject

Metadata in a form of map<str, bool | str | int | array[str]>.

namestringrequired

The name of the vault.

created_byPersonRef (object) or ApiUserRef (object) or ApiSignerRef (object) or EndUserRef (object) or SystemUserRef (object)required
One of:

Details of the vault creator.

vault_groupobjectrequired

The vault group this vault belongs to.

pending_vault_group_actionany

Details of pending vault movement to another vault group.

statestringrequired

State of the vault.

Enum"active""archived"
public_key_compressedstringrequired

The public key of the vault in its compressed form:

  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the SEC1 standard.
  • For EdDSA, the public key is represented as a 32-byte value, as defined by RFC 8032.

Example: "SGVsbG8="
derivation_infoobjectrequired

The derivation info of the vault.

key_holderobject

The user who owns the keyset of the vault. If not provided, the vault is owned by the organization.

origin_typestringrequired

The origin type of the vault.

Enum"native""imported"
typestringrequired

Aptos vault type.

Discriminator
Value "aptos"
addressstring= 66 characters^0[xX][a-fA-F0-9]+$required

The address of the vault on Aptos chain types.

Example: "0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "modified_at": "2019-08-24T14:15:22Z",
  "metadata": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "name": "string",
  "created_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user_type": "person",
    "name": "John Doe",
    "email": "string",
    "state": "active",
    "role": "admin"
  },
  "vault_group": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "vault_count": 0,
    "can_current_user_create_or_edit_vaults": true
  },
  "pending_vault_group_action": {
    "type": "add",
    "vault_group_id": "948d8050-0dde-409f-985b-6d7b133fc9e8",
    "vault_group_name": "string"
  },
  "state": "active",
  "public_key_compressed": "SGVsbG8=",
  "derivation_info": {
    "derivation_path": "m/44/60/0/0/0",
    "master_public_key": { … }
  },
  "key_holder": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user_type": "end_user",
    "external_id": "user|1234",
    "state": "active"
  },
  "origin_type": "native",
  "type": "aptos",
  "address": "0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a"
}

Get Vault Asset

Request

Get a specific asset in a vault.

Security
bearerAuth
Path
idstring(uuid)required

ID of the vault to retrieve.

asset_idstring(uuid)required

ID of the asset to retrieve.

Query
pageinteger>= 1

The page number to fetch.

Default 1
sizeinteger[ 0 .. 100 ]

The number of items per page.

Default 50
curl -i -X GET \
  'https://api.fordefi.com/api/v1/vaults/{id}/assets/{asset_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
priced_assetobjectrequired
balancesobjectrequired

The cryptocurrency balances of the asset.

Response
application/json
{
  "priced_asset": {
    "type": "asset_price",
    "asset_info": { … },
    "price": { … }
  },
  "balances": {
    "total_mined": "1000000000000000000",
    "total_pending_incoming": "1000000000000000000",
    "mined": "1000000000000000000",
    "pending_incoming": "1000000000000000000",
    "frozen_mined": "1000000000000000000",
    "frozen_pending_incoming": "1000000000000000000"
  }
}

Get Vault Assets

Request

Get a list of all assets in a vault.

Security
bearerAuth
Path
idstring(uuid)required

ID of the vault to retrieve.

Query
pageinteger>= 1

The page number to fetch.

Default 1
sizeinteger[ 0 .. 100 ]

The number of items per page.

Default 50
chainsArray of strings
asset_idsArray of strings(uuid)
is_hiddenboolean
searchstring
sort_byArray of strings
Items Enum"asset_name_asc""asset_name_desc""chain_identifier_asc""chain_identifier_desc""balance_asc""balance_desc""market_value_asc""market_value_desc""price_asc""price_desc"
curl -i -X GET \
  'https://api.fordefi.com/api/v1/vaults/{id}/assets' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
totalintegerrequired
pageintegerrequired
sizeintegerrequired
owned_assetsArray of objectsrequired
Response
application/json
{
  "total": 0,
  "page": 0,
  "size": 0,
  "owned_assets": [
    { … }
  ]
}

Archive Vault

Request

Archive an existing vault.

Security
bearerAuth
Path
idstring(uuid)required

ID of the vault to archive.

curl -i -X POST \
  'https://api.fordefi.com/api/v1/vaults/{id}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response
No content

Restore Vault

Request

Restore an archived vault.

Security
bearerAuth
Path
idstring(uuid)required

ID of the vault to restore.

curl -i -X POST \
  'https://api.fordefi.com/api/v1/vaults/{id}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response
No content

Rename Vault

Request

Rename an existing vault.

Security
bearerAuth
Path
idstring(uuid)required

ID of the vault to rename.

Bodyapplication/jsonrequired
namestringnon-emptyrequired

The new name for the vault.

curl -i -X PUT \
  'https://api.fordefi.com/api/v1/vaults/{id}/name' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

Successful Response

Response
No content

Create Address

Request

Create a new address.

Security
bearerAuth
Path
idstring(uuid)required

ID of the vault to create address in.

Bodyapplication/jsonrequired
namestringnon-empty

The name of the address.

address_typestring

The type of the address.

Default "segwit"
Enum"legacy""segwit""taproot"
import_addressobject

Additional information when creating an address from an imported key. This field is relevant only for organizations using imported keys.Imported addresses much be either of type LEGACY or SEGWIT.

curl -i -X POST \
  'https://api.fordefi.com/api/v1/vaults/{id}/addresses' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "address_type": "legacy",
    "import_address": {
      "derivation_path": "m/44/60/0/0/0"
    }
  }'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)required

The unique identifier of the object in the Fordefi platform.

created_atstring(date-time)required

The date and time when the object was created.

modified_atstring(date-time)required

The date and time when the object was last modified. Any change to any field of the resource is considered a modification.

vaultobjectrequired

The vault this address belongs to.

namestringrequired

The name of the address.

public_key_compressedstringrequired

The compressed public key of the address. As defined in the SEC1 standard: https://www.secg.org/SEC1-Ver-1.0.pdf.

Example: "SGVsbG8="
derivation_pathstringrequired

The BIP-32 derivation path of the address.

Example: "m/44/60/0/0/0"
typestringrequired

The type of the vault address.

Value "utxo"
addressobjectrequired

The address on the chain.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "modified_at": "2019-08-24T14:15:22Z",
  "vault": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "vault_group_id": "948d8050-0dde-409f-985b-6d7b133fc9e8",
    "name": "string",
    "address": "string",
    "state": "active",
    "type": "aptos",
    "logo_url": "http://example.com",
    "end_user": { … }
  },
  "name": "string",
  "public_key_compressed": "SGVsbG8=",
  "derivation_path": "m/44/60/0/0/0",
  "type": "utxo",
  "address": {
    "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
    "address_type": "legacy",
    "chain": { … }
  }
}

List Vault Addresses

Request

Get a list of all addresses in a vault.

Security
bearerAuth
Path
idstring(uuid)required

ID of the vault.

Query
sort_byArray of strings
Items Enum"created_at_asc""created_at_desc""name_asc""name_desc"
pageinteger>= 1

The page number to fetch.

Default 1
sizeinteger[ 0 .. 100 ]

The number of items per page.

Default 50
searchstring
addressesArray of strings

List of addresses to filter on.

address_typesArray of strings

List of address types to filter on.

Items Enum"legacy""p2sh""segwit""taproot"
curl -i -X GET \
  'https://api.fordefi.com/api/v1/vaults/{id}/addresses' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
totalintegerrequired
pageintegerrequired
sizeintegerrequired
addressesArray of objectsrequired
Response
application/json
{
  "total": 0,
  "page": 0,
  "size": 0,
  "addresses": [
    { … }
  ]
}

Rename Vault Address

Request

Rename an existing vault address.

Security
bearerAuth
Path
idstring(uuid)required

ID of the vault address to rename.

Bodyapplication/jsonrequired
namestringnon-emptyrequired

The new name for the vault.

curl -i -X PUT \
  'https://api.fordefi.com/api/v1/vaults/addresses/{id}/name' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

Successful Response

Response
No content

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

Audit Log

These endpoints allow you to manage audit logs.

Audit logs are used to track the actions of users in your organization.

Operations

Exports

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

Operations

Organizations

Operations