New Release
Guardian 3.7.0
Ctrlk
Release NotesCalendar
youtube
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tokens

Manage Hedera tokens representing environmental assets and carbon credits.

Return a list of tokens.

get

Returns all tokens. For the Standard Registry role it returns only the list of tokens, for other users it also returns token balances as well as the KYC, Freeze, and Association statuses. Not allowed for the Auditor role.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
policyIdstringOptional

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
statusstring · enumOptional

Token status

Possible values:
pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
Responses
200

Successful operation.

application/json
get/tokens
GET /api/v1/tokens HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-10T13:18:36.660Z",
    "updateDate": "2026-03-10T13:18:36.660Z",
    "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
    "tokenName": "VCU",
    "tokenSymbol": "VCU",
    "tokenType": "non-fungible",
    "decimals": 0,
    "initialSupply": 0,
    "adminId": null,
    "changeSupply": true,
    "enableAdmin": true,
    "enableKYC": true,
    "enableFreeze": true,
    "enableWipe": true,
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "policyId": null,
    "draftToken": true,
    "id": "69b01a2c3f674c474aa928e4",
    "policies": [
      "VM0042 10/27 (DRAFT)"
    ],
    "policyIds": [
      "69b01a323f674c474aa931ba"
    ],
    "canDelete": true,
    "associated": false,
    "frozen": false,
    "kyc": false,
    "balance": "0"
  }
]

Creates a new token.

post

Creates a new token. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
tokenIdstringRequired

Hedera token ID (assigned after token creation on Hedera)

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
initialSupplystringRequired

Initial supply of the token (set to 0 for mintable tokens)

Example: 0
decimalsstringRequired

Number of decimal places (0 for NFTs, typically 2 for fungible tokens)

Example: 2
changeSupplybooleanRequired

Enable Supply key — allows minting and burning tokens

Example: true
enableAdminbooleanRequired

Enable Admin key — allows managing token properties

Example: true
enableFreezebooleanRequired

Enable Freeze key — allows freezing token transfers for specific accounts

Example: false
enableKYCbooleanRequired

Enable KYC key — allows granting/revoking KYC status for accounts

Example: true
enableWipebooleanRequired

Enable Wipe key — allows wiping token balance from specific accounts

Example: true
Responses
201

Successful operation.

application/json
tokenIdstringRequired

Hedera token ID (assigned after token creation on Hedera)

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
initialSupplystringRequired

Initial supply of the token (set to 0 for mintable tokens)

Example: 0
decimalsstringRequired

Number of decimal places (0 for NFTs, typically 2 for fungible tokens)

Example: 2
changeSupplybooleanRequired

Enable Supply key — allows minting and burning tokens

Example: true
enableAdminbooleanRequired

Enable Admin key — allows managing token properties

Example: true
enableFreezebooleanRequired

Enable Freeze key — allows freezing token transfers for specific accounts

Example: false
enableKYCbooleanRequired

Enable KYC key — allows granting/revoking KYC status for accounts

Example: true
enableWipebooleanRequired

Enable Wipe key — allows wiping token balance from specific accounts

Example: true
post/tokens
POST /api/v1/tokens HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 669

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true
}
[
  {
    "createDate": "2026-03-10T13:18:36.660Z",
    "updateDate": "2026-03-10T13:18:36.660Z",
    "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
    "tokenName": "VCU",
    "tokenSymbol": "VCU",
    "tokenType": "non-fungible",
    "decimals": 0,
    "initialSupply": 0,
    "adminId": null,
    "changeSupply": true,
    "enableAdmin": true,
    "enableKYC": true,
    "enableFreeze": true,
    "enableWipe": true,
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "policyId": null,
    "draftToken": true,
    "id": "69b01a2c3f674c474aa928e4",
    "policies": [
      "VM0042 10/27 (DRAFT)"
    ],
    "policyIds": [
      "69b01a323f674c474aa931ba"
    ],
    "canDelete": true,
    "associated": false,
    "frozen": false,
    "kyc": false,
    "balance": "0"
  }
]

Update token.

put

Update token. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
tokenIdstringRequired

Hedera token ID (assigned after token creation on Hedera)

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
initialSupplystringRequired

Initial supply of the token (set to 0 for mintable tokens)

Example: 0
decimalsstringRequired

Number of decimal places (0 for NFTs, typically 2 for fungible tokens)

Example: 2
changeSupplybooleanRequired

Enable Supply key — allows minting and burning tokens

Example: true
enableAdminbooleanRequired

Enable Admin key — allows managing token properties

Example: true
enableFreezebooleanRequired

Enable Freeze key — allows freezing token transfers for specific accounts

Example: false
enableKYCbooleanRequired

Enable KYC key — allows granting/revoking KYC status for accounts

Example: true
enableWipebooleanRequired

Enable Wipe key — allows wiping token balance from specific accounts

Example: true
Responses
201

Updated token.

application/json
tokenIdstringRequired

Hedera token ID (assigned after token creation on Hedera)

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
initialSupplystringRequired

Initial supply of the token (set to 0 for mintable tokens)

Example: 0
decimalsstringRequired

Number of decimal places (0 for NFTs, typically 2 for fungible tokens)

Example: 2
changeSupplybooleanRequired

Enable Supply key — allows minting and burning tokens

Example: true
enableAdminbooleanRequired

Enable Admin key — allows managing token properties

Example: true
enableFreezebooleanRequired

Enable Freeze key — allows freezing token transfers for specific accounts

Example: false
enableKYCbooleanRequired

Enable KYC key — allows granting/revoking KYC status for accounts

Example: true
enableWipebooleanRequired

Enable Wipe key — allows wiping token balance from specific accounts

Example: true
put/tokens
PUT /api/v1/tokens HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "tokenId": "0.0.6046500",
  "tokenName": "Carbon Credit Token",
  "tokenSymbol": "CCT",
  "tokenType": "fungible",
  "initialSupply": "0",
  "decimals": "2",
  "changeSupply": true,
  "enableAdmin": true,
  "enableFreeze": false,
  "enableKYC": true,
  "enableWipe": true
}
{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true
}

Return a token by id.

get

Return the token.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token identifier

Example: 69aeb71ef8c5b278e3bab4e5
Query parameters
policyIdstringOptional

Optional policy ID to filter linked policies in response

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
tokenIdstringRequired

Hedera token ID (assigned after token creation on Hedera)

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
initialSupplystringRequired

Initial supply of the token (set to 0 for mintable tokens)

Example: 0
decimalsstringRequired

Number of decimal places (0 for NFTs, typically 2 for fungible tokens)

Example: 2
changeSupplybooleanRequired

Enable Supply key — allows minting and burning tokens

Example: true
enableAdminbooleanRequired

Enable Admin key — allows managing token properties

Example: true
enableFreezebooleanRequired

Enable Freeze key — allows freezing token transfers for specific accounts

Example: false
enableKYCbooleanRequired

Enable KYC key — allows granting/revoking KYC status for accounts

Example: true
enableWipebooleanRequired

Enable Wipe key — allows wiping token balance from specific accounts

Example: true
get/tokens/{tokenId}
GET /api/v1/tokens/{tokenId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true
}

Creates a new token.

post

Creates a new token. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
tokenIdstringRequired

Hedera token ID (assigned after token creation on Hedera)

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
initialSupplystringRequired

Initial supply of the token (set to 0 for mintable tokens)

Example: 0
decimalsstringRequired

Number of decimal places (0 for NFTs, typically 2 for fungible tokens)

Example: 2
changeSupplybooleanRequired

Enable Supply key — allows minting and burning tokens

Example: true
enableAdminbooleanRequired

Enable Admin key — allows managing token properties

Example: true
enableFreezebooleanRequired

Enable Freeze key — allows freezing token transfers for specific accounts

Example: false
enableKYCbooleanRequired

Enable KYC key — allows granting/revoking KYC status for accounts

Example: true
enableWipebooleanRequired

Enable Wipe key — allows wiping token balance from specific accounts

Example: true
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
post/tokens/push
POST /api/v1/tokens/push HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "tokenId": "0.0.6046500",
  "tokenName": "Carbon Credit Token",
  "tokenSymbol": "CCT",
  "tokenType": "fungible",
  "initialSupply": "0",
  "decimals": "2",
  "changeSupply": true,
  "enableAdmin": true,
  "enableFreeze": false,
  "enableKYC": true,
  "enableWipe": true
}
{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}

Update token.

put

Update token. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
tokenIdstringRequired

Hedera token ID (assigned after token creation on Hedera)

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
initialSupplystringRequired

Initial supply of the token (set to 0 for mintable tokens)

Example: 0
decimalsstringRequired

Number of decimal places (0 for NFTs, typically 2 for fungible tokens)

Example: 2
changeSupplybooleanRequired

Enable Supply key — allows minting and burning tokens

Example: true
enableAdminbooleanRequired

Enable Admin key — allows managing token properties

Example: true
enableFreezebooleanRequired

Enable Freeze key — allows freezing token transfers for specific accounts

Example: false
enableKYCbooleanRequired

Enable KYC key — allows granting/revoking KYC status for accounts

Example: true
enableWipebooleanRequired

Enable Wipe key — allows wiping token balance from specific accounts

Example: true
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
put/tokens/push
PUT /api/v1/tokens/push HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "tokenId": "0.0.6046500",
  "tokenName": "Carbon Credit Token",
  "tokenSymbol": "CCT",
  "tokenType": "fungible",
  "initialSupply": "0",
  "decimals": "2",
  "changeSupply": true,
  "enableAdmin": true,
  "enableFreeze": false,
  "enableKYC": true,
  "enableWipe": true
}
{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}

Deletes the token with the provided schema ID.

delete

Deletes the token with the provided schema ID. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
delete/tokens/push/{tokenId}
DELETE /api/v1/tokens/push/{tokenId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}

Delete multiple tokens.

post

Delete multiple tokens by their IDs. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
tokenIdsstring[]RequiredExample: ["69aeb71ef8c5b278e3bab4e5"]
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
post/tokens/push/delete-multiple
POST /api/v1/tokens/push/delete-multiple HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "tokenIds": [
    "69aeb71ef8c5b278e3bab4e5"
  ]
}
{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}

Associates the user with the provided Hedera token.

put

Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/tokens/{tokenId}/associate
PUT /api/v1/tokens/{tokenId}/associate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true,
  "associated": false,
  "frozen": false,
  "kyc": false,
  "balance": "0"
}

Associates the user with the provided Hedera token.

put

Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
put/tokens/push/{tokenId}/associate
PUT /api/v1/tokens/push/{tokenId}/associate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}

Associate the user with the provided Hedera token.

put

Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/tokens/{tokenId}/dissociate
PUT /api/v1/tokens/{tokenId}/dissociate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true,
  "associated": false,
  "frozen": false,
  "kyc": false,
  "balance": "0"
}

Associate the user with the provided Hedera token.

put

Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
put/tokens/push/{tokenId}/dissociate
PUT /api/v1/tokens/push/{tokenId}/dissociate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}

Transfers tokens from the authenticated user to the target account.

post

Transfers fungible or non-fungible tokens from the authenticated user's Hedera account to the specified target account. For FT, specify amount. For NFT, specify serialNumbers or amount (picks from end).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
Body
targetAccountstringRequired

Target Hedera account ID

Example: 0.0.12345
amountnumberOptional

Amount (FT) or serial count to pick (NFT); must be > 0

Example: 10
serialNumbersnumber[]Optional

Specific NFT serial numbers to transfer; positive integers

Example: [1,2,3]
memostringOptional

Optional transaction memo

Responses
200

Successful operation.

No content
post/tokens/{tokenId}/transfer
POST /api/v1/tokens/{tokenId}/transfer HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "targetAccount": "0.0.12345",
  "amount": 10,
  "serialNumbers": [
    1,
    2,
    3
  ],
  "memo": "text"
}
No content

Transfers tokens from the authenticated user to the target account.

post

Transfers fungible or non-fungible tokens asynchronously. Returns a task ID for tracking.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
Body
targetAccountstringRequired

Target Hedera account ID

Example: 0.0.12345
amountnumberOptional

Amount (FT) or serial count to pick (NFT); must be > 0

Example: 10
serialNumbersnumber[]Optional

Specific NFT serial numbers to transfer; positive integers

Example: [1,2,3]
memostringOptional

Optional transaction memo

Responses
200

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
post/tokens/push/{tokenId}/transfer
POST /api/v1/tokens/push/{tokenId}/transfer HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "targetAccount": "0.0.12345",
  "amount": 10,
  "serialNumbers": [
    1,
    2,
    3
  ],
  "memo": "text"
}
{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 8,
  "action": "Create tool",
  "userId": "69bcfd90c98df6ceb05e8a78"
}

Sets the KYC flag for the user.

put

Sets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
usernamestringRequired

Username

Example: username
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/tokens/{tokenId}/{username}/grant-kyc
PUT /api/v1/tokens/{tokenId}/{username}/grant-kyc HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true,
  "associated": false,
  "frozen": false,
  "kyc": false,
  "balance": "0"
}

Sets the KYC flag for the user.

put

Sets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
usernamestringRequired

Username

Example: username
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
put/tokens/push/{tokenId}/{username}/grant-kyc
PUT /api/v1/tokens/push/{tokenId}/{username}/grant-kyc HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}

Unsets the KYC flag for the user.

put

Unsets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
usernamestringRequired

Username

Example: username
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/tokens/{tokenId}/{username}/revoke-kyc
PUT /api/v1/tokens/{tokenId}/{username}/revoke-kyc HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true,
  "associated": false,
  "frozen": false,
  "kyc": false,
  "balance": "0"
}

Unsets the KYC flag for the user.

put

Unsets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
usernamestringRequired

Username

Example: username
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
put/tokens/push/{tokenId}/{username}/revoke-kyc
PUT /api/v1/tokens/push/{tokenId}/{username}/revoke-kyc HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}

Freeze transfers of the specified token for the user.

put

Freezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
usernamestringRequired

Username

Example: username
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/tokens/{tokenId}/{username}/freeze
PUT /api/v1/tokens/{tokenId}/{username}/freeze HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true,
  "associated": false,
  "frozen": false,
  "kyc": false,
  "balance": "0"
}

Unfreezes transfers of the specified token for the user.

put

Unfreezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
usernamestringRequired

Username

Example: username
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/tokens/{tokenId}/{username}/unfreeze
PUT /api/v1/tokens/{tokenId}/{username}/unfreeze HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true,
  "associated": false,
  "frozen": false,
  "kyc": false,
  "balance": "0"
}

Freeze transfers of the specified token for the user.

put

Freezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
usernamestringRequired

Username

Example: username
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
put/tokens/push/{tokenId}/{username}/freeze
PUT /api/v1/tokens/push/{tokenId}/{username}/freeze HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}

Unfreezes transfers of the specified token for the user.

put

Unfreezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
usernamestringRequired

Username

Example: username
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
put/tokens/push/{tokenId}/{username}/unfreeze
PUT /api/v1/tokens/push/{tokenId}/{username}/unfreeze HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}

Returns user information for the selected token.

get

Returns user information for the selected token. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
usernamestringRequired

Username

Example: username
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
get/tokens/{tokenId}/{username}/info
GET /api/v1/tokens/{tokenId}/{username}/info HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true,
  "associated": false,
  "frozen": false,
  "kyc": false,
  "balance": "0"
}

Return token serials.

get

Returns token serials of current user.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Token serials.

application/json
number[]Optional
get/tokens/{tokenId}/serials
GET /api/v1/tokens/{tokenId}/serials HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Return a list of tokens.

get

Returns tokens menu. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Modules.

application/json
tokenIdstringRequired

Hedera token ID (assigned after token creation on Hedera)

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
initialSupplystringRequired

Initial supply of the token (set to 0 for mintable tokens)

Example: 0
decimalsstringRequired

Number of decimal places (0 for NFTs, typically 2 for fungible tokens)

Example: 2
changeSupplybooleanRequired

Enable Supply key — allows minting and burning tokens

Example: true
enableAdminbooleanRequired

Enable Admin key — allows managing token properties

Example: true
enableFreezebooleanRequired

Enable Freeze key — allows freezing token transfers for specific accounts

Example: false
enableKYCbooleanRequired

Enable KYC key — allows granting/revoking KYC status for accounts

Example: true
enableWipebooleanRequired

Enable Wipe key — allows wiping token balance from specific accounts

Example: true
get/tokens/menu/all
GET /api/v1/tokens/menu/all HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-10T13:18:36.660Z",
    "updateDate": "2026-03-10T13:18:36.660Z",
    "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
    "tokenName": "VCU",
    "tokenSymbol": "VCU",
    "tokenType": "non-fungible",
    "decimals": 0,
    "initialSupply": 0,
    "adminId": null,
    "changeSupply": true,
    "enableAdmin": true,
    "enableKYC": true,
    "enableFreeze": true,
    "enableWipe": true,
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "policyId": null,
    "draftToken": true,
    "id": "69b01a2c3f674c474aa928e4",
    "policies": [
      "VM0042 10/27 (DRAFT)"
    ],
    "policyIds": [
      "69b01a323f674c474aa931ba"
    ],
    "canDelete": true,
    "associated": false,
    "frozen": false,
    "kyc": false,
    "balance": "0"
  }
]

Returns user information for the selected token.

get

Returns user information for the selected token. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
relayerAccountIdstringRequired

Relayer Account Id

Example: 0.0.6046379
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
get/tokens/{tokenId}/relayer-accounts/{relayerAccountId}/info
GET /api/v1/tokens/{tokenId}/relayer-accounts/{relayerAccountId}/info HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true,
  "associated": false,
  "frozen": false,
  "kyc": false,
  "balance": "0"
}

Associates the user with the provided Hedera token.

put

Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
accountIdstringRequired

Account ID

Example: 0.0.6046379
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/tokens/{tokenId}/associate/{accountId}
PUT /api/v1/tokens/{tokenId}/associate/{accountId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true,
  "associated": false,
  "frozen": false,
  "kyc": false,
  "balance": "0"
}

Associates the user with the provided Hedera token.

put

Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
accountIdstringRequired

Account ID

Example: 0.0.6046379
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
put/tokens/push/{tokenId}/associate/{accountId}
PUT /api/v1/tokens/push/{tokenId}/associate/{accountId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}

Associate the user with the provided Hedera token.

put

Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
accountIdstringRequired

Account ID

Example: 0.0.6046379
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring · enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/tokens/{tokenId}/dissociate/{accountId}
PUT /api/v1/tokens/{tokenId}/dissociate/{accountId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-10T13:18:36.660Z",
  "updateDate": "2026-03-10T13:18:36.660Z",
  "tokenId": "737a27a4-5706-4d87-b5a2-c8a12c45d109",
  "tokenName": "VCU",
  "tokenSymbol": "VCU",
  "tokenType": "non-fungible",
  "decimals": 0,
  "initialSupply": 0,
  "adminId": null,
  "changeSupply": true,
  "enableAdmin": true,
  "enableKYC": true,
  "enableFreeze": true,
  "enableWipe": true,
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": null,
  "draftToken": true,
  "id": "69b01a2c3f674c474aa928e4",
  "policies": [
    "VM0042 10/27 (DRAFT)"
  ],
  "policyIds": [
    "69b01a323f674c474aa931ba"
  ],
  "canDelete": true,
  "associated": false,
  "frozen": false,
  "kyc": false,
  "balance": "0"
}

Associate the user with the provided Hedera token.

put

Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenIdstringRequired

Token ID

Example: 69aeb71ef8c5b278e3bab4e5
accountIdstringRequired

Account ID

Example: 0.0.6046379
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
put/tokens/push/{tokenId}/dissociate/{accountId}
PUT /api/v1/tokens/push/{tokenId}/dissociate/{accountId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "f3b2a9c1e4d5678901234567",
  "expectation": 0
}
PreviousWizard
NextContracts

Last updated

Was this helpful?