Set up a Fireblocks API Key

Fireblocks permits API access by setting up an API user. The steps below guide you through what's required to set a new API user up properly for Liquifi to interact with.

Step 1: Request required setup items to use for your Fireblocks API user key creation

• CSR File: Your Liquifi onboarding manager will provide you the CSR file to use. When creating the API Key user in Fireblocks, you will need to upload the provided CSR file in Fireblocks to create the API user.

• Liquifi Factory Contract address: Your Liquifi onboarding manager will also need to provide you the current Liquifi factory contract address according to your network.

Step 2: Create the API user with the Liquifi CSR file

• In this step, you will need to create a new API user key in Fireblocks and upload the CSR file from the step above. 

1. Create an API user on Fireblocks (video walkthrough):

   • API user parameters:

     • Name: Liquifi API Key

     • Role: Editor (this is the lowest level of access required for sufficient actions to be permitted via Liquifi)

     • CSR File: Request from your onboarding manager

Step 3: Set up TAP for API Key user 

• After creating the API user, you'll need to set up a few transaction policies (TAPs) for the newly created API Key user. These TAP policies give the least amount of access needed in order for the API key to perform the necessary functions.

1. Rule #1: Contract Call (video walkthrough)

   • Type: Contract call

   • Source: Fireblocks vault being used for Liquifi

   • Destination: Whitelisted addresses only

   • Contract call methods: Any

   • Initiated by: Liquifi API key (your newly created API user)

   • Designated signer: Any real user within your Fireblocks account (i.e., not the API user)

   • Asset: Any

   • Action: Approved by: TBD based on customer preference

2. Rule #2: Transfer (video walkthrough)

   • Type: Transfer

   • Source: Fireblocks vault being used for Liquifi

   • Destination: Whitelisted addresses only

   • Initiated by: Liquifi API key (your newly created API user)

   • Designated signer: Any real user within your Fireblocks account (i.e., not the API user)

   • Asset: Any and no minimum amount

   • Action: Approved by: TBD based on customer preference

3. Publish TAP rules (video walkthrough)

Step 4: Allowlist the Liquifi contract addresses

• Next, you will need to explicitly allowlist Liquifi's smart contract addresses. 

1. Allowlist Factory Contract (*Only required for new accounts) (video walkthrough): 

   • Whitelisted wallet type: Contract

   • Name: Liquifi Factory Contract

   • Gas Token: Based on network

   • Liquifi Factory Contract Address: Must be requested from your onboarding manager based on your token's network

2. Allowlist Vesting Contract (video walkthrough): 

   1. NEW ACCOUNTS: If you're setting up a new account, you must complete two steps before you have an escrow address generated that you can allowlist:

      • Publish at least one token grant

      • Publish your account on-chain

   2. Addresses to allowlist

      • Liquifi Escrow Address

        • Type: Contract

        • Name: Liquifi Escrow Contract Address

          • Add address

            • Select correct gas token for the network

              Address: Escrow contract address from within your Liquifi

      • Liquifi Distributing Token Address

        • Type: External

          Name: Liquifi Distribution Token Address

          • Add Address

            • Select the token that’s being distributed via Liquifi

            • Address: Escrow contract address from within Liquifi

Step 5: Share your API key credentials

• In order to complete the Fireblocks account set up process, you must provide the following information for our technical team to set up within your account. Please share these credentials via a secure note (such as 1Password) or a private DM to your onboarding manager. Do not post your API key credentials in a group or public channel.

• Fireblocks API Key

  • You can copy the API key from from the API user profile in the Users page of your Fireblocks account

• Fireblocks Vault URL

  • We require this in order to identify the vault ID.

  • This must be the vault that will contain the vesting tokens.

  • You can identify this by navigating to the Accounts page in your Fireblocks account and copying the URL (e.g., The Fireblocks URL https://console.fireblocks.io/v2/accounts/vault/19 identifies that the vault ID is 19.

• Fireblocks API ID

  • To find this, navigate to your vault's list of tokens and hover over the token you plan to distribute via Liquifi to view a pop-up screen.

  • Please copy and share the ID noted there

    • See screenshot below for an example: