https://api.fordefi.com/
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:
The Users API is currently read-only. To add/remove users, visit the Fordefi web console.
These endpoints allow you to manually trigger your pre-configured webhooks.
Use Webhooks describes how to configure webhooks, validate them, and resend them.
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.
Signature of the body. Base64 encoded string. If the request is made programatically by an API user, signing of the request is required and is intended to protect you from malicious backends.
The type of the chain.
The address on the Aptos chain.
The chains the contact belongs to.
https://api.fordefi.com/api/v1/addressbook/contacts
curl -i -X POST \
https://api.fordefi.com/api/v1/addressbook/contacts \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'x-signature: SGVsbG8=' \
-H 'x-timestamp: 0' \
-d '{
"name": "string",
"type": "aptos",
"address": "0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a",
"chains": [
"aptos_mainnet"
],
"assets_identifiers": [
{
"type": "aptos",
"details": {
"type": "native",
"chain": "aptos_mainnet"
}
}
]
}'Successful Response
The date and time when the object was last modified. Any change to any field of the resource is considered a modification.
Address last modifier.
A list of asset infos for the contact. Can be used to enforce trading of specific assets intransfers to this address
The type of the chain.
The address on the aptos chain.
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "modified_at": "2019-08-24T14:15:22Z", "name": "string", "modified_by": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user_type": "person", "name": "John Doe", "email": "string", "state": "active", "role": "admin" }, "state": "pending", "groups": [ { … } ], "pending_changes": { "is_being_edited": true, "change_request_id": "f90819c3-6f40-44d9-9518-d77c485c0c12", "change_request_reason": "creation" }, "asset_infos": [ { … } ], "chain_type": "aptos", "address": "0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a", "chains": [ { … } ] }
https://api.fordefi.com/api/v1/addressbook/contacts
curl -i -X GET \
'https://api.fordefi.com/api/v1/addressbook/contacts?address_group_ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&asset_ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&chain_types=aptos&chains=string&contact_ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&exclude_address_group_ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&names=string&page=1&size=50&sort_by=created_at_asc&states=pending' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "total": 0, "page": 0, "size": 0, "contacts": [ { … } ] }
https://api.fordefi.com/api/v1/addressbook/contacts/{id}/proposals/{proposal_id}/abort
curl -i -X POST \
'https://api.fordefi.com/api/v1/addressbook/contacts/{id}/proposals/{proposal_id}/abort' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Signature of the body. Base64 encoded string. If the request is made programatically by an API user, signing of the request is required and is intended to protect you from malicious backends.
The type of the chain.
The Aptos chain's unique ID.
https://api.fordefi.com/api/v1/addressbook/contacts/{id}/proposals
curl -i -X POST \
'https://api.fordefi.com/api/v1/addressbook/contacts/{id}/proposals' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'x-signature: SGVsbG8=' \
-H 'x-timestamp: 0' \
-d '{
"name": "string",
"type": "aptos",
"chains": [
"aptos_mainnet"
],
"assets_identifiers": [
{
"type": "aptos",
"details": {
"type": "native",
"chain": "aptos_mainnet"
}
}
]
}'These endpoints allow you to manage transactions on the Fordefi platform.
A transaction represents an operation that can be one of the following:
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.
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).
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.
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.
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.