Skip to main content
POST
/
tokenization
/
tokens
/
link
TypeScript
const response: Promise<FireblocksResponse<TokenLinkDto>> = fireblocks.tokenization.link(tokenizationApiLinkRequest);
{
  "id": "fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb",
  "status": "COMPLETED",
  "type": "NON_FUNGIBLE_TOKEN",
  "refId": "BQ5R_MY_TOKEN",
  "displayName": "My Simple ERC20 Token",
  "tokenMetadata": {
    "assetId": "BQ5R_MY_TOKEN",
    "name": "MyToken",
    "symbol": "MYT",
    "networkProtocol": "ETH",
    "totalSupply": "1000000000000000",
    "holdersCount": "6",
    "type": "ERC20",
    "contractAddress": "0x1234567890abcdef1234567890abcdef12345678",
    "issuerAddress": "rGyXjc5d7s17vvt3NtKKascvJrnSxV21kQ",
    "testnet": true,
    "blockchain": "ETH_TEST5",
    "decimals": 18,
    "vaultAccountId": "0"
  }
}

Documentation Index

Fetch the complete documentation index at: https://fireblocks-43c4b3ee-chore-add-cli.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Idempotency-Key
string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Body

application/json
​
type
enum<string>
required

The type of token being linked

Available options:
FUNGIBLE_TOKEN,
NON_FUNGIBLE_TOKEN,
TOKEN_UTILITY,
TOKEN_EXTENSION
​
refId
string

The Fireblocks' token link reference id. For example, 'BQ5R_BDESC_ABC' if it's a fungible asset

Example:

"USDC_ETH_TEST3_1XF5"

​
displayName
string

The token display name

Example:

"My Simple ERC20 Token"

​
baseAssetId
string

The blockchain base assetId

Example:

"ETH_TEST3"

​
contractAddress
string

The contract's onchain address

Example:

"0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66"

Response

Token linked successfully

​
id
string
required

The token link id

Example:

"fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb"

​
status
enum<string>
required

The token status

Available options:
PENDING,
COMPLETED
Example:

"COMPLETED"

​
type
enum<string>

The type of token

Available options:
FUNGIBLE_TOKEN,
NON_FUNGIBLE_TOKEN,
TOKEN_UTILITY,
TOKEN_EXTENSION
Example:

"NON_FUNGIBLE_TOKEN"

​
refId
string

The Fireblocks' reference id

Example:

"BQ5R_MY_TOKEN"

​
displayName
string

The token display name. If was not provided, would be taken from the contract template

Example:

"My Simple ERC20 Token"

​
tokenMetadata
object

The token's metadata