📘

Want to know more about the Provider Network and commercial prerequisites?

Visit our Help Center article about the Provider Network to learn more.

See the Fireblocks Provider Connectivity API v2 documentation on GitHub to learn how to connect your service to Fireblocks.

Registering as a service provider

Once your license agreement for listing your service with Fireblocks is signed, the Fireblocks technical team will request the following connected account registration settings:

1. Display name (e.g., "My Exchange" or "My Exchange Sandbox")
2. Icon (a 32x32 .svg file)
3. Step-by-step guide for generating an API key for your platform
   1. A public link to your knowledge base is preferred. A shareable document or PDF is also acceptable.
4. Base URL for your API endpoints (e.g., "https://my-service.com/fireblocks")
5. Will your service provide a sandbox environment?
6. For Off-Exchange capabilities, please provide your CSR file.
7. User credentials for testing
8. Which signing method will your server use for all requests? Please choose one of the supported options by specifying the pre-encoding function, signing algorithm, and post-encoding function during the server onboarding process.
   1. Pre-encoding options:
      1. URL encoded
      2. Base64
      3. HexStr
      4. Base58
      5. Base32
   2. Signing algorithms & possible hash functions:
      1. HMAC (SHA512, SHA3_256, or SHA256)
      2. RSA PKCS1v15 (SHA512, SHA3_256, or SHA256)
      3. ECDSA prime256v1/secp256k1 (SHA256 only)
   3. Post-encoding options: (URL encoding not supported)
      1. Base64
      2. HexStr
      3. Base58
      4. Base32
9. Validation tool results

IP allowlisting

All API calls from Fireblocks to your service are sent from a fixed set of IP addresses, grouped by geographical region. Your service should allowlist these addresses to allow Fireblocks communication with your servers.

Mandatory endpoints implementation per user flow

Minimum viable provider

• RequiredGET /capabilities response: "accounts": ["*"]
• Required endpoints:
  • GET /capabilities
  • GET /capabilities/assets
  • GET /accounts
  • GET /accounts/{accountId}

Balance support

• RequiredGET /capabilities response: "accounts": ["*"], "balances": ["*"]
• Required endpoints:
  • GET /accounts/{accountId}/balances

Transfer support

• RequiredGET /capabilities response: "accounts": ["*"], "balances": ["*"], "transfers": ["*"]
• Required endpoints:
  • GET /accounts/{accountId}/capabilities/transfers/deposits
  • GET /accounts/{accountId}/capabilities/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/deposits
  • GET /accounts/{accountId}/transfers/deposits/{id}
  • GET /accounts/{accountId}/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/withdrawals/{id}

Blockchain transfer

• RequiredGET /capabilities response: "accounts": ["*"], "balances": ["*"], "transfers": ["*"], "transfersBlockchain": ["*"]
• Required endpoints:
  • GET /accounts/{accountId}/capabilities/transfers/deposits
  • GET /accounts/{accountId}/capabilities/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/deposits
  • GET /accounts/{accountId}/transfers/deposits/{id}
  • GET /accounts/{accountId}/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/withdrawals/{id}
  • POST /accounts/{accountId}/transfers/deposits/addresses
  • GET /accounts/{accountId]/transfers/deposits/addresses
  • GET /accounts/{accountId}/transfers/deposits/addresses/{id}
  • POST /accounts/{accountId}/transfers/withdrawals/blockchain

Peer transfer

• RequiredGET /capabilities response: "accounts": ["*"], "balances": ["*"], "transfers": ["*"], "transfersPeerAccounts": ["*"]
  • For fiat assets, add "transfersFiat": ["*"] to the response.
• Required endpoints:
  • GET /accounts/{accountId}/capabilities/transfers/deposits
  • GET /accounts/{accountId}/capabilities/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/deposits
  • GET /accounts/{accountId}/transfers/deposits/{id}
  • GET /accounts/{accountId}/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/withdrawals/{id}
  • POST /accounts/{accountId}/transfers/withdrawals/peeraccount

Internal transfer

• RequiredGET /capabilities response: "accounts": ["*"], "balances": ["*"], "transfers": ["*"], "transfersInternal": ["*"]
  • For fiat assets, add "transfersFiat": ["*"] to the response.
• Required endpoints:
  • GET /accounts/{accountId}/capabilities/transfers/deposits
  • GET /accounts/{accountId}/capabilities/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/deposits
  • GET /accounts/{accountId}/transfers/deposits/{id}
  • GET /accounts/{accountId}/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/withdrawals/{id}
  • POST /accounts/{accountId}/transfers/withdrawals/subaccount

Fiat transfer

• RequiredGET /capabilities response: "accounts": ["*"], "balances": ["*"], "transfers": ["*"], "transfersFiat": ["*"]
• Required endpoints:
  • GET /accounts/{accountId}/capabilities/transfers/deposits
  • GET /accounts/{accountId}/capabilities/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/deposits
  • GET /accounts/{accountId}/transfers/deposits/{id}
  • GET /accounts/{accountId}/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/withdrawals/{id}
  • POST /accounts/{accountId}/transfers/withdrawals/fiat

Trading support

• RequiredGET /capabilities response: "accounts": ["*"], "balances": ["*"], "trading": ["*"]
• Required endpoints:
  • GET /capabilities/trading/books
  • GET /trading/books/{id}
  • GET /accounts/{accountId}/trading/orders
  • POST /accounts/{accountId}/trading/orders
  • GET /accounts/{accountId}/trading/orders/{id}
  • GET /accounts/{accountId}/trading/books/{id}/history

Liquidity/RFQ support

• RequiredGET /capabilities response: "accounts": ["*"], "balances": ["*"], "liquidity": ["*"]
• Required endpoints:
  • GET /capabilities/liquidity/quotes
  • POST /accounts/{accountId}/liquidity/quotes
  • GET /accounts/{accountId}/liquidity/quotes
  • GET /accounts/{accountId}/liquidity/quotes/{id}
  • POST /accounts/{accountId}/liquidity/quotes/{id}/execute

On-/Off-Ramp & Bridging

• RequiredGET /capabilities response: "accounts": ["*"], "ramps": ["*"], "balances": ["*"]
  • For prefunded flows, "balances": ["*"] must be returned with GET account API. See below.
• Required endpoints:
  • GET /accounts/{accountId}/capabilities/ramps
  • POST /accounts/{accountId}/ramps
  • GET /accounts/{accountId}/ramps
  • GET /accounts/{accountId}/ramps/{id}
  • GET /accounts/{accountId}/balances (only for prefunded flows)
  • GET /accounts/{accountId}/rate
    • Your service should implement the rate endpoint to ensure Fireblocks customers see your service's real-time rates for asset pairs. Otherwise, Fireblocks defaults to quotes or its internal rating service.

Collateral

• RequiredGET /capabilities response: "accounts": ["*"], "balances": ["*"], "transfers": ["*"], "transfersBlockchain": ["*"], "collateral": ["*"]
• Required endpoints:
  • GET /accounts/{accountId}/balances
  • GET /accounts/{accountId}/capabilities/transfers/deposits
  • GET /accounts/{accountId}/capabilities/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/deposits
  • GET /accounts/{accountId}/transfers/deposits/{id}
  • GET /accounts/{accountId}/transfers/withdrawals
  • GET /accounts/{accountId}/transfers/withdrawals/{id}
  • POST /accounts/{accountId}/transfers/deposits/addresses
  • GET /accounts/{accountId}/transfers/deposits/addresses
  • GET /accounts/{accountId}/transfers/deposits/addresses/{id}
  • POST /accounts/{accountId}/transfers/withdrawals/blockchain
• Collateral endpoints:
  • POST accounts/{accountId}/collateral/link
  • GET accounts/{accountId}/collateral/link
  • POST accounts/{accountId}/collateral/{collateralId}/addresses
  • GET accounts/{accountId}/collateral/{collateralId}/addresses
  • GET accounts/{accountId}/collateral/{collateralId}/addresses/{id}
  • POST accounts/{accountId}/collateral/{collateralId}/intents/deposits
  • POST accounts/{accountId}/collateral/{collateralId}/deposits
  • GET accounts/{accountId}/collateral/{collateralId}/deposits
  • GET accounts/{accountId}/collateral/{collateralId}/deposits/{collateralTxId}
  • POST accounts/{accountId}/collateral/{collateralId}/intents/withdrawals
  • POST accounts/{accountId}/collateral/{collateralId}/withdrawals
  • GET accounts/{accountId}/collateral/{collateralId}/withdrawals
  • GET accounts/{accountId}/collateral/{collateralId}/withdrawals/{collateralTxId}
  • POST accounts/{accountId}/collateral/{collateralId}/settlement
  • GET accounts/{accountId}/collateral/{collateralId}/settlement
  • GET accounts/{accountId}/collateral/{collateralId}/settlements/{settlementVersion}