Fordefi API (0.2.0)

Download OpenAPI description

openapi.json

openapi.yaml

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:

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.

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

Create Batch Transaction

Request

Create a batch of transactions.
Batch transactions are currently supported only on Solana.

Headers

x-signaturestring

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.

Example: SGVsbG8=

x-timestampinteger

Timestamp of the signature. Integer. Specify an Epoch date. If the request is made programatically by an API user, the timestamp of the request is required and is intended to protect you from replay attacks.

x-idempotence-idstring(uuid)

Optional idempotence ID of a transaction.

Bodyapplication/jsonrequired

vault_idstring(uuid)required

The unique identifier of the vault.

notestring

An optional transaction note.

signer_typestring

The signer of the transaction. Can be:

initiator: The creator of the transaction (default).
api_signer: A service that you run on your own network or cloud environment.
end_user: A mobile device using Fordefi's SDK.

Default "initiator"

Enum"initiator""api_signer""end_user""multiple_signers"

sign_modestring

The sign mode of the transaction determines when the transaction will transition to the signing phase. It can be one of the following:

auto: The transaction will move to signing automatically after approval.
triggered: The transaction will be in the waiting_for_signing_trigger state until "Trigger Transaction Signing" is called. Currently supported only for API Signer signer type.

Default "auto"

Enum"auto""triggered"

dapp_infoobject

The dapp info.

typestringrequired

Solana transaction type.

Discriminator

Value "solana_transaction"

detailsobjectrequired

curl -i -X POST \
  https://api.fordefi.com/api/v1/batch-transactions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-idempotence-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-signature: SGVsbG8=' \
  -H 'x-timestamp: 0' \
  -d '{
    "vault_id": "432b199b-1f71-42bf-ba0b-33d512afa9de",
    "note": "string",
    "signer_type": "initiator",
    "sign_mode": "auto",
    "dapp_info": {
      "url": "string",
      "name": "string"
    },
    "type": "solana_transaction",
    "details": {
      "type": "solana_raw_transaction",
      "fail_on_prediction_failure": true,
      "push_mode": "auto",
      "fee": {
        "type": "custom",
        "priority_fee": "1000000000000000000"
      },
      "skip_prediction": false,
      "chain": "solana_mainnet",
      "transactions": [
        {
          "version": "legacy",
          "instructions": [
            {
              "program_index": 0,
              "data": "SGVsbG8=",
              "account_indexes": [
                0
              ]
            }
          ],
          "accounts": [
            {
              "address": "4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA",
              "writable": true,
              "signer": true,
              "ephemeral_key": "lnNyP8kFPEaVpvUo/SIlhdZlzhPU8r7yT/h0gG5ajzQ="
            }
          ],
          "address_table_lookups": [
            {
              "account_key": "4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA",
              "writable_indexes": [
                0
              ],
              "readonly_indexes": [
                0
              ]
            }
          ],
          "signatures": [
            {
              "data": "SGVsbG8="
            }
          ],
          "recent_blockhash": "4sGjMW1sUnHzSxGspuhpqLDx6wiyjNtZAMdL4VZHirAn"
        }
      ]
    }
  }'

Responses

Successful Response

Bodyapplication/json

batch_idstring(uuid)required

ID of the batch of transactions.

transactionsArray of anyrequired

Response

application/json

{
  "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
  "transactions": [
    { … }
  ]
}

Predict Batch Transaction

Request

Simulate the batch of transactions and show changes in token balances, in addition to the fee estimation
Batch transactions are currently supported only on Solana.

Bodyapplication/jsonrequired

vault_idstring(uuid)required

The unique identifier of the vault.

notestring

An optional transaction note.

typestringrequired

The type of the transaction.

Discriminator

Value "solana_transaction"

detailsanyrequired

curl -i -X POST \
  https://api.fordefi.com/api/v1/batch-transactions/predict \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "vault_id": "432b199b-1f71-42bf-ba0b-33d512afa9de",
    "note": "string",
    "type": "solana_transaction",
    "details": {
      "type": "solana_raw_transaction",
      "fail_on_prediction_failure": true,
      "skip_simulation": false,
      "fee": {
        "type": "custom",
        "priority_fee": "1000000000000000000"
      },
      "chain": "solana_mainnet",
      "transactions": [
        {
          "version": "legacy",
          "instructions": [
            {
              "program_index": 0,
              "data": "SGVsbG8=",
              "account_indexes": [
                0
              ]
            }
          ],
          "accounts": [
            {
              "address": "4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA",
              "writable": true,
              "signer": true,
              "ephemeral_key": "lnNyP8kFPEaVpvUo/SIlhdZlzhPU8r7yT/h0gG5ajzQ="
            }
          ],
          "address_table_lookups": [
            {
              "account_key": "4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA",
              "writable_indexes": [
                0
              ],
              "readonly_indexes": [
                0
              ]
            }
          ],
          "signatures": [
            {
              "data": "SGVsbG8="
            }
          ],
          "recent_blockhash": "4sGjMW1sUnHzSxGspuhpqLDx6wiyjNtZAMdL4VZHirAn"
        }
      ]
    }
  }'

Responses

Successful Response

Bodyapplication/json

aml_policy_matchobject

The AML policy match.

policy_matchobjectrequired

The policy match.

approval_requestobject

The approval request.

risksArray of objectsrequired

The list of risks associated with this transaction.

notestring

An optional transaction note.

aml_resultsobject

The AML results.

typestringrequired

The type of the transaction.

Discriminator

Value "solana_transaction"

expected_resultobjectrequired

The expected result of the transaction in case it is mined.

chainobjectrequired

The details of the chain that this message is on.

simulation_status_resultobjectrequired

Whether simulation succeeded, reverted or failed.

solana_transaction_type_detailsanyrequired

Details of the Solana transaction based on its type.

senderobjectrequired

The sender of the transaction.

suggested_feesobjectrequired

The suggested fees.

instructionsArray of objectsrequired

The instructions of the transaction.

raw_transactionstring

The serialized transaction encoded as a base64 string

Example: "SGVsbG8="

was_fee_set_in_requestbooleanrequired

Whether the priority fee was already set in the request with a ComputeBudget instruction.

Response

application/json

{
  "aml_policy_match": {
    "is_default": true,
    "rule_id": "728c1541-d6d1-4290-9a53-cdf01dd32d60",
    "rule_name": "string",
    "action_type": "allow"
  },
  "policy_match": {
    "is_default": true,
    "rule_id": "728c1541-d6d1-4290-9a53-cdf01dd32d60",
    "rule_name": "string",
    "action_type": "allow"
  },
  "approval_request": {
    "state": "created",
    "required_groups": 0,
    "approval_groups": [ … ],
    "error_message": "string"
  },
  "risks": [
    { … }
  ],
  "note": "string",
  "aml_results": {
    "scan_status": "error",
    "error_message": "string",
    "scan_results": { … }
  },
  "type": "solana_transaction",
  "expected_result": {
    "reversion": { … },
    "transaction_error": "string",
    "fee": "1000000000000000000",
    "enriched_fee": { … },
    "effects": { … },
    "instruction_error": { … }
  },
  "chain": {
    "chain_type": "solana",
    "unique_id": "solana_mainnet",
    "name": "string",
    "native_currency_symbol": "ETH",
    "native_currency_name": "Ether",
    "blockchain_explorer": { … },
    "logo_url": "http://example.com",
    "is_testnet": true,
    "is_enabled": true
  },
  "simulation_status_result": {
    "simulation_status": "success",
    "details": "string"
  },
  "solana_transaction_type_details": {
    "type": "native_transfer",
    "direction": "outgoing",
    "sender": { … },
    "recipient": { … },
    "is_internal": true
  },
  "sender": {
    "vault": { … },
    "explorer_url": "http://example.com",
    "contact": { … },
    "type": "solana",
    "address": "4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA",
    "contract": { … }
  },
  "suggested_fees": {
    "type": "solana",
    "chain_unique_id": "solana_mainnet",
    "base_fee": "1000000000000000000",
    "low": "1000000000000000000",
    "medium": "1000000000000000000",
    "high": "1000000000000000000"
  },
  "instructions": [
    { … }
  ],
  "raw_transaction": "SGVsbG8=",
  "was_fee_set_in_request": true
}

Abort Batch Transaction

Request

Abort a batch of transactions.

Path

batch_idstring(uuid)required

ID of the batch of transactions.

curl -i -X POST \
  'https://api.fordefi.com/api/v1/batch-transactions/{batch_id}/abort' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response

No content

Approve Batch Transaction

Request

Approve a batch of transactions.

Path

batch_idstring(uuid)required

ID of the batch of transactions.

curl -i -X POST \
  'https://api.fordefi.com/api/v1/batch-transactions/{batch_id}/approve' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response

No content

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

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

Fordefi API (0.2.0)

Users

Authorization Tokens

Blockchains

Webhooks

Address Book

Transactions

Batch Transactions

Create Batch Transaction

Request

Responses

Was this helpful?

Predict Batch Transaction

Request

Responses

Was this helpful?

Abort Batch Transaction

Request

Responses

Was this helpful?

Approve Batch Transaction

Request

Responses

Was this helpful?

Vaults

Vault Groups

Assets

End Users

User Groups

Audit Log

Exports

Organizations