Tokenization

Create a new collection

Create a new collection and link it as a token. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor.

post/tokenization/collections

Request

Headers

Idempotency-Keystring

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.

Request body

baseAssetIdstring required

The blockchain base assetId

vaultAccountIdstring required

The id of the vault account that initiated the request to issue the token

type'NON_FUNGIBLE_TOKEN' | 'SEMI_FUNGIBLE_TOKEN' required

The type of collection

namestring required

A string that represents the name of the collection

symbolstring required

A string that represents the symbol of the collection

adminAddressstring required

The EVM address of the user that will be set as the admin user of the collection

displayNamestring

A string to display as a name of the collection

Example request

{
  "baseAssetId": "ETH",
  "vaultAccountId": "0",
  "name": "DigitalArtTokens",
  "symbol": "DAT",
  "adminAddress": "0x5503766D27d1ED4525f5053222E18b29C38eDdB2",
  "displayName": "DigitalArtTokens"
}

Response

Collection was created successfully

idstring required

The collection id

status'PENDING' | 'COMPLETED' required

The collection status

type'NON_FUNGIBLE_TOKEN' | 'SEMI_FUNGIBLE_TOKEN' required

The type of collection

displayNamestring

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

Example response

{
  "id": "fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb",
  "status": "COMPLETED",
  "displayName": "My Simple ERC721 Collection",
  "collectionMetadata": {
    "fbCollectionId": "911fe739f0d4d123c98fd366c3bed35c6e30c00e",
    "name": "Rarible",
    "symbol": "RARI",
    "blockchainDescriptor": "ETH",
    "contractAddress": "0x1723017329a804564bC8d215496C89eaBf1F3211"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.