Add Asset to Sub-Entity Vault

This endpoint adds a blockchain asset to the institution associated with the auth token. Once added, the sub-institution gets a dedicated blockchain wallet address for that asset, enabling it to send, receive, and manage balances for that specific asset.

POST {{host}}/api/v1/institutions/sub-entity/asset/add

Content-Type: application/json

Request Message Description

#	Field Name	Data Type	Max Length (API)	Max Length (UI)	Required	Description
1	`assetId`	String	-	-	Yes	Unique identifier of the blockchain asset to be added to the sub-institution (e.g. `CNGN_B75VRLGX_8GWM`)
2	`entityId`	Int	-	-	Yes	Unique internal ID of the sub-entity the blockchain asset is added to

Sample Request

{
  "assetId": "CNGN_B75VRLGX_8GWM",
  "entityId": "78"
}

Response Message Field Description

#	Field Name	Description
1	`success`	Indicates whether the request was successful (`true` for success)
2	`responseCode`	HTTP-like response code (e.g. `200` for success)
3	`responseMessage`	Human-readable result message (e.g. `Success`)
4	`data`	Object containing details of the asset added to the sub-institution
4.1	`data.institutionId`	Unique internal ID of the parent institution of the sub-entity the asset was added to
4.2	`data.vaultId`	Vault identifier associated with the sub-institution
4.3	`data.assetId`	Unique identifier of the blockchain asset that was added
4.4	`data.address`	Blockchain wallet address generated for this sub-institution and asset
4.5	`data.availableBalance`	Current available balance of the asset in the sub-institution's wallet
4.6	`data.frozenBalance`	Amount of the asset currently frozen and unavailable for transactions

Sample Response (Success)

{
  "success": true,
  "responseCode": "200",
  "responseMessage": "Success",
  "data": {
    "institutionId": 2,
    "subInstitutionId": "78",
    "vaultId": "94",
    "assetId": "CNGN_B75VRLGX_8GWM",
    "address": "0x632E8..............",
    "availableBalance": "0",
    "frozenBalance": "0"
  }
}

Sample Response (Failure)

{
  "success": false,
  "responseCode": "404",
  "responseMessage": "Entity Not Found"
}