API ENDPOINTS¶

List of API Endpoints¶

Entity Name	Method	Description
Digital Asset	`create`	Create data
	`retrieve`	Retrieve data in digital asset
	`retrieve by ID`	Retrieve from blockchain
	`update`	Update data
	`delete`	Delete data
Blockchain Adapter	`invoke`	Invoke data
	`query`	Query data
	`get balance`	Get balance

Digital Asset¶

1. Create¶

Property	Details
Endpoint URL	`/api/v1/digital-assets`
HTTP Method	`POST`
Brief Description	Create a brand-new asset on chain and return its metadata.

Request Body:

{
  "id": "asset5",
  "Total": "299"
}

Response Body:

{
  "message": "New Asset has been successfully created!!",
  "data": {
    "transaction": {
      "asset_id": "eff95299-9edf-4d5f-9c55-ec55f0f86fbe",
      "data": {
        "rr": "rr"
      },
      "ledger_txid": "01163090bcb9b284eb066ab18e416bacef95a9488771b21ad56a7ac37312ad41",
      "status": "COMMITTED",
      "created_at": "2025-09-30T01:08:56.403Z"
    }
  }
}

2. Retrieve¶

Property	Details
Endpoint URL	`/api/v1/digital-assets`
HTTP Method	`GET`
Brief Description	Fetch a list of every asset belonging to your subscription.

Request Body:

N/A

Response Body:

href="#__codelineno-3-1">{ "message": "Blockchain assets retrieved successfully", "verifiedAssets": [ { "asset_id": "9e8a639b-75d9-43ad-b965-3933fc4bbb4a", "subscription_id": "540b7414-f227-4512-9b69-c56af9283eb1", "data": { "test": "1" }, "ledger_txid": "c53e3c25d152d1af09138c9a0592491ced1d3cd26fbbf732cd36aa00e182a021", "status": "COMMITTED", "created_at": "2025-09-04T08:59:40.404Z" }, { "asset_id": "e13aa1ff-e9f0-4b80-903a-39da4b419667", "subscription_id": "540b7414-f227-4512-9b69-c56af9283eb1", "data": { "test": "2" }, "ledger_txid": "21188f0923fb4cd15391066bd9211e98b4fafa90d3507f2de81d6cbbd6775108", "status": "COMMITTED", "created_at": "2025-09-11T03:34:15.207Z" }, { "asset_id": "d6b881d5-4f6a-4bef-ba4e-4db94a2fdc98", "subscription_id": "540b7414-f227-4512-9b69-c56af9283eb1", "data": { "tret": "tret" }, "ledger_txid": "c0b9737ff649a8e914a502ad98ec5c63e52a66aad39eda65c13b910591da1188", "status": "COMMITTED", "created_at": "2025-09-30T00:59:00.794Z" }, { "asset_id": "8eff8aaa-c340-49e6-93de-2967c24bcc2b", "subscription_id": "540b7414-f227-4512-9b69-c56af9283eb1", "data": { "hash": "226edff04e928bd00a296c0424c16a90dcb127a505144bbad0b8fdcb8dab2903", "size": 764142, "mimeType": "application/pdf", "documentID": "1759194071667-PVC-25001_SRF-AP_PG3_P1_BC_AEO__OGA_API_Document_DagangNet_signed.pdf", "originalName": "PVC-25001_SRF-AP_PG3_P1_BC_AEO__OGA_API_Document_DagangNet_signed.pdf" }, "ledger_txid": "cc8d211215abb8b8c24a252334b300c74b0130aed1179e7662d86e08e4d63fa1", "status": "COMMITTED", "created_at": "2025-09-30T01:01:14.264Z" }, { "asset_id": "eff95299-9edf-4d5f-9c55-ec55f0f86fbe", "subscription_id": "540b7414-f227-4512-9b69-c56af9283eb1", "data": { "rr": "rr" }, "ledger_txid": "01163090bcb9b284eb066ab18e416bacef95a9488771b21ad56a7ac37312ad41", "status": "COMMITTED", "created_at": "2025-09-30T01:08:56.403Z" } ] }

3. Update¶

Property	Details
Endpoint URL	`/api/v1/digital-assets/{assetId}`
HTTP Method	`PUT`
Brief Description	Mutate existing fields on an asset. Only send the properties you intend to update.

Request Body:

{
  "description": "Updated description",
  "faceValue": 1200
}

Response Body:

{
  "status": "OK",
  "message": "Asset updated successfully"
}

4. Delete¶

Property	Details
Endpoint URL	`/api/v1/digital-assets/{assetId}`
HTTP Method	`DELETE`
Brief Description	Irrevocably delete an asset

Request Body:

{
  "assetId": "string"
}

Response Body:

{
  "status": "OK",
  "message": "Asset removed"
}

5. Upload Document¶

Property	Details
Endpoint URL	`/api/v1/document/upload`
HTTP Method	`POST`
Brief Description	Uploads a document to the system and stores its reference on blockchain.

Request Body:

Response Body:

{
  "message": "Document uploaded and asset recorded successfully.",
  "data": {
    "asset": {
      "asset_id": "d532f3a5-4b3d-4bce-9721-e31cd749129a",
      "subscription_id": "540b7414-f227-4512-9b69-c56af9283eb1",
      "status": "CREATED",
      "created_by": "cdf2c4a7-c21b-4d7c-85c3-95756f4242fd",
      "updated_by": "cdf2c4a7-c21b-4d7c-85c3-95756f4242fd",
      "is_deleted": false,
      "created_at": "2025-09-30T07:45:56.091Z",
      "updated_at": "2025-09-30T07:45:56.091Z"
    },
    "transaction": {
      "transaction_id": "2899acf0-bad7-4a7f-a9b2-ac1fd1ebe8de",
      "asset_id": "d532f3a5-4b3d-4bce-9721-e31cd749129a",
      "subscription_id": "540b7414-f227-4512-9b69-c56af9283eb1",
      "asset_name": "1759218353406-PVC-25001_SRF-AP_PG3_P1_BC_AEO__OGA_API_Document_DagangNet_signed (1).pdf",
      "details": "txId: ba0ae9f5cc06172d7b95d7de09c9531084a855b208e738a3296564f6ec1e859b",
      "data": {
        "hash": "226edff04e928bd00a296c0424c16a90dcb127a505144bbad0b8fdcb8dab2903",
        "size": 764142,
        "mimeType": "application/pdf",
        "documentID": "1759218353406-PVC-25001_SRF-AP_PG3_P1_BC_AEO__OGA_API_Document_DagangNet_signed (1).pdf",
        "originalName": "PVC-25001_SRF-AP_PG3_P1_BC_AEO__OGA_API_Document_DagangNet_signed (1).pdf"
      },
      "ledger_txid": "ba0ae9f5cc06172d7b95d7de09c9531084a855b208e738a3296564f6ec1e859b",
      "status": "COMMITTED",
      "created_by": "cdf2c4a7-c21b-4d7c-85c3-95756f4242fd",
      "updated_by": "cdf2c4a7-c21b-4d7c-85c3-95756f4242fd",
      "is_deleted": false,
      "created_at": "2025-09-30T07:45:56.091Z",
      "updated_at": "2025-09-30T07:45:56.091Z"
    },
    "document": {
      "id": "1759218353406-PVC-25001_SRF-AP_PG3_P1_BC_AEO__OGA_API_Document_DagangNet_signed (1).pdf",
      "path": "/app/hyperledger_fabric/data/uploads/1759218353406-PVC-25001_SRF-AP_PG3_P1_BC_AEO__OGA_API_Document_DagangNet_signed (1).pdf",
      "hash": "226edff04e928bd00a296c0424c16a90dcb127a505144bbad0b8fdcb8dab2903",
      "metadata": {
        "size": 764142,
        "mimeType": "application/pdf",
        "uploadedAt": "2025-09-30T07:45:56.098Z",
        "originalName": "PVC-25001_SRF-AP_PG3_P1_BC_AEO__OGA_API_Document_DagangNet_signed (1).pdf"
      },
      "transaction_id": "ba0ae9f5cc06172d7b95d7de09c9531084a855b208e738a3296564f6ec1e859b",
      "subscription_id": "540b7414-f227-4512-9b69-c56af9283eb1",
      "created_by": "cdf2c4a7-c21b-4d7c-85c3-95756f4242fd",
      "created_at": "2025-09-30T07:45:56.091Z",
      "updated_at": "2025-09-30T07:45:56.091Z"
    }
  }
}

6. Upload Document Status¶

Property	Details
Endpoint URL	`/api/v1/document/upload/status`
HTTP Method	`GET`
Brief Description	Retrieves upload status or metadata of uploaded documents.

Request Body:

Response Body:

{
  "success": true,
  "documents": [
    {
      "id": "1759281076554-PVC-25001_SRF-AP_PG3_P1_BC_AEO__OGA_API_Document_DagangNet_signed (1).pdf",
      "hash": "226edff04e928bd00a296c0424c16a90dcb127a505144bbad0b8fdcb8dab2903",
      "transaction_id": "d08b4c13ff353d4c1ec247a00fadf93b646b9acc8d63ee60cb26be0bc7f493b8",
      "subscription_id": "540b7414-f227-4512-9b69-c56af9283eb1",
      "originalname": "PVC-25001_SRF-AP_PG3_P1_BC_AEO__OGA_API_Document_DagangNet_signed (1).pdf",
      "mimetype": "application/pdf",
      "size": "764142",
      "uploadedat": "2025-10-01T01:11:19.519Z",
      "created_by": "cdf2c4a7-c21b-4d7c-85c3-95756f4242fd",
      "created_at": "2025-10-01T01:11:19.510Z"
    }
  ]
}

API ENDPOINTS¶

List of API Endpoints¶

Digital Asset¶

1. Create¶

2. Retrieve¶

3. Update¶

4. Delete¶

5. Upload Document¶

6. Upload Document Status¶

Blockchain Adapter - Pending Completion¶

1. Invoke¶

2. Query¶

3. Get Balance¶