REST API

You can access the Rest API through the Swagger UI from the App API section. Navigate to Network -> Deployed Apps -> App -> Rest API

You can register API Keys at the Network level and use them to access the API endpoints of the deployed chaincode applications on the network. API Key

Base URL

https://<membership_id>.spydra.app/tokenize/<app_id>

Get the base URL from Network -> Deployed Apps -> App -> Rest API page.
Select your organization at the top right of this page.
Alternatively, you can from the URL by getting the <membership_id> by navigating
to Network -> Members page and getting the <app_id> by navigating to the Network -> 
Deployed Apps -> App Overview page.

Assets

An asset can be any object in your business process that needs to be tracked on the Blockchain. For e.g. financial instruments (equities, bonds, loans, and funds), tangible assets (real estate, artworks, precious metals), or intellectual property can be different types of assets.

Query an asset.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset

Authorization

Query parameters

Response

Asset found.

Body

idstring

Id of the asset.

Example: "Prop1"

assetTypestring

The type of asset defined in the Asset Tokenization App settings.

Example: "Property"

dataobject

Custom JSON object representing an asset.

ownersarray of entity (object)

The current owners of the asset.

createdAtstring

Date and time when the asset was created on the ledger.

Example: "2023-02-15T15:47:00.027Z"

createdByentity (object)

updatedAtstring

Date and time when the asset was last updated on the ledger.

Example: "2023-02-17T12:10:24.156Z"

updatedByentity (object)

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset?assetType=text&id=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "Prop1",
  "assetType": "Property",
  "data": {
    "id": "Prop1",
    "name": "Flat xyz",
    "address": "Chicago, Illinois",
    "locality": "Harbor Drive"
  },
  "owners": [
    {
      "orgId": "63c912fd5902d6c20ac43c89",
      "userId": "123"
    }
  ],
  "createdAt": "2023-02-15T15:47:00.027Z",
  "createdBy": {
    "orgId": "63c912fd5902d6c20ac43c89",
    "userId": "123"
  },
  "updatedAt": "2023-02-17T12:10:24.156Z",
  "updatedBy": {
    "orgId": "63c912fd5902d6c20ac43c89",
    "userId": "123"
  }
}

Create an asset or a list of assets.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset

Authorization

Query parameters

Body

assetType*string

The type of asset defined in the Asset Tokenization App settings.

Example: "Property"

data*array of object

Custom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.

Response

Asset created.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "assetType": "Property",
      "data": [
        {
          "id": "Prop1",
          "name": "Flat xyz",
          "address": "Chicago, Illinois",
          "locality": "Harbor Drive"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Create or update an asset or a list of assets. If an asset with the same id exists, the existing asset will be updated.

PUThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset

Authorization

Query parameters

Body

assetType*string

The type of asset defined in the Asset Tokenization App settings.

Example: "Property"

data*array of object

Custom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.

Response

Asset created.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "assetType": "Property",
      "data": [
        {
          "id": "Prop1",
          "name": "Flat xyz",
          "address": "Chicago, Illinois",
          "locality": "Harbor Drive"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Delete one or more assets.

DELETEhttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset

Authorization

Query parameters

Body

assetType*string

The type of asset defined in the Asset Tokenization App settings.

Example: "Property"

id*array of string

Id of the asset. This is the Id that is maintained in your system and corresponds to the value of the Primary Key attribute defined in the Asset Tokenization App settings. You can submit a single id or multiple Ids in one request by providing an array here.

Response

Asset deleted.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "assetType": "Property",
      "id": [
        "Prop1"
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Update an asset or a list of assets.

PATCHhttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset

Authorization

Query parameters

Body

assetType*string

The type of asset defined in the Asset Tokenization App settings.

Example: "Property"

data*array of object

Custom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.

Response

Asset updated.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "assetType": "Property",
      "data": [
        {
          "id": "Prop1",
          "name": "Flat xyz",
          "address": "Chicago, Illinois",
          "locality": "Harbor Drive"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Update owners of an asset. This method replaces the current owners with the new owner array provided.

PATCHhttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/owners

Authorization

Query parameters

Body

assetType*string

The type of asset defined in the Asset Tokenization App settings.

Example: "Property"

data*array of object

Ownership change data. Supports ownership change for single asset or bulk change for an array of assets.

Response

Asset updated.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/owners', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "assetType": "Property",
      "data": [
        {
          "id": "Prop1",
          "owners": [
            {
              "orgId": "63c912fd5902d6c20ac43c89"
            }
          ]
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Get the asset along with history of changes.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/history

Authorization

Query parameters

Response

Asset found

Body

idstring

Id of the asset.

Example: "Prop1"

assetTypestring

The type of asset defined in the Asset Tokenization App settings.

Example: "Property"

countinteger

The number of historical entries returned from the ledger.

Example: 1

recordsarray of object

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/history?assetType=text&id=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "Prop1",
  "assetType": "Property",
  "count": 1,
  "records": [
    {
      "trasactionType": "CREATED",
      "transactionId": "6c94ff55155722c28611630e7d6795145e0282e9fabf10bf3460f396e2a6218b",
      "transactionTime": "2023-02-16T11:55:07.776Z",
      "data": {
        "id": "Prop1",
        "name": "Flat xyz",
        "address": "Chicago, Illinois",
        "locality": "Harbor Drive"
      },
      "owners": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123"
        }
      ],
      "createdAt": "2023-02-15T15:47:00.027Z",
      "createdBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      },
      "updatedAt": "2023-02-17T12:10:24.156Z",
      "updatedBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      }
    }
  ]
}

Get all assets.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/all

Authorization

Query parameters

Response

Assets found.

Body

countinteger

The number of records returned from the ledger.

Example: 1

bookmarkstring

The bookmark returned to be submitted in request for next page.

recordsarray of AssetResponse (object)

Assets returned.

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/all?assetType=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "count": 1,
  "bookmark": "text",
  "records": [
    {
      "id": "Prop1",
      "assetType": "Property",
      "data": {
        "id": "Prop1",
        "name": "Flat xyz",
        "address": "Chicago, Illinois",
        "locality": "Harbor Drive"
      },
      "owners": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123"
        }
      ],
      "createdAt": "2023-02-15T15:47:00.027Z",
      "createdBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      },
      "updatedAt": "2023-02-17T12:10:24.156Z",
      "updatedBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      }
    }
  ]
}

Get the status of an already submitted transaction using the returned receipt id.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/receipt

Authorization

Query parameters

Response

Transaction found.

Body

transactionIdstring

The ledger transaction Id corresponding to the receipt id.

Example: "6c94ff55155722c28611630e7d6795145e0282e9fabf10bf3460f396e2a6218b"

statusenum

The status of the submitted transaction.

COMMITTEDFAILEDINITIATED

messagestring

Error message when the transaction status is FAILED.

Example: "Success"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/receipt?receiptId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "transactionId": "6c94ff55155722c28611630e7d6795145e0282e9fabf10bf3460f396e2a6218b",
  "status": "COMMITTED",
  "message": "Success"
}

Get statistics about asset usage.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/stats

Authorization

Response

Body

totalCountinteger

Total number of assets on the ledger.

Example: 100

countByTypearray of object

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/stats', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "totalCount": 100,
  "countByType": [
    {
      "assetType": "Property",
      "count": 30
    }
  ]
}

Asset Ownership

Get ownership transfer request by id.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request

Authorization

Query parameters

Response

Ownership transfer request found

Body

idstring

Id of the ownership transfer request.

Example: "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134"

approversarray of all of

The approver(s) to whom the request was sent for approval.

numRequirednumber

The number of approvers required to approve.

Example: 1

statusenum

The status of the request

PENDINGAPPROVEDREJECTEDCANCELLED

timeoutnumber

The number of minutes after which the approval request should timeout after it has been created.

Example: 60

dataobject

Any additional data that is meaningful to be stored in the approval request.

ownersarray of entity (object)

The owners of the transfer request. This is typically same as the approvers.

createdAtstring

Date and time when the ownership transfer request was created on the ledger.

Example: "2023-02-15T15:47:00.027Z"

createdByentity (object)

updatedAtstring

Date and time when the ownership transfer request was last updated on the ledger.

Example: "2023-02-17T12:10:24.156Z"

updatedByentity (object)

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request?id=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134",
  "approvers": [
    {
      "orgId": "63c912fd5902d6c20ac43c89",
      "userId": "123",
      "status": "PENDING"
    }
  ],
  "numRequired": 1,
  "status": "PENDING",
  "timeout": 60,
  "data": {
    "name": "Flat xyz",
    "address": "Chicago, Illinois",
    "locality": "Harbor Drive",
    "metadata": {
      "assetType": "Property",
      "id": [
        "Prop1"
      ],
      "newOwner": {
        "orgId": "641b0eb2623fc30540d70fa7",
        "userId": "6002"
      }
    }
  },
  "owners": [
    {
      "orgId": "63c912fd5902d6c20ac43c89",
      "userId": "123"
    }
  ],
  "createdAt": "2023-02-15T15:47:00.027Z",
  "createdBy": {
    "orgId": "63c912fd5902d6c20ac43c89",
    "userId": "123"
  },
  "updatedAt": "2023-02-17T12:10:24.156Z",
  "updatedBy": {
    "orgId": "63c912fd5902d6c20ac43c89",
    "userId": "123"
  }
}

Request ownership of an asset to be transferred.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request

Authorization

Query parameters

Body

assetType*string

The type of asset defined in the Asset Tokenization App settings.

Example: "Property"

approvals*array of object

The ownership transfer approval request to be submitted. Multiple transfer requests can be submitted together by providing an array here.

Response

Ownership transfer request created.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "assetType": "Property",
      "approvals": [
        {
          "id": [
            "Prop1"
          ],
          "approvers": [
            {
              "orgId": "63c912fd5902d6c20ac43c89"
            }
          ]
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Approve ownership transfer request.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/approve

Authorization

Query parameters

Body

id*array of string

Id of the approval request. You can approve multiple ownership transfer requests together by providing an array of Ids here.

Response

Ownership transfer request approved.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/approve', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": [
        "641821e82c44573cb52c7d97"
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Reject ownership transfer request.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/reject

Authorization

Query parameters

Body

id*array of string

Id of the approval request. You can approve multiple ownership transfer requests together by providing an array of Ids here.

Response

Ownership transfer request rejected.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/reject', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": [
        "641821e82c44573cb52c7d97"
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Get the status of ownership transfer requests submitted by an entity.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request/my

Authorization

Query parameters

Response

Ownership transfer request found

Body

countinteger

The number of records returned.

Example: 3

bookmarkstring

The bookmark returned by previous request.

recordsarray of OwnershipTransferResponse (object)

The records returned.

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request/my', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "count": 3,
  "bookmark": "text",
  "records": [
    {
      "id": "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134",
      "approvers": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123",
          "status": "PENDING"
        }
      ],
      "numRequired": 1,
      "status": "PENDING",
      "timeout": 60,
      "data": {
        "name": "Flat xyz",
        "address": "Chicago, Illinois",
        "locality": "Harbor Drive",
        "metadata": {
          "assetType": "Property",
          "id": [
            "Prop1"
          ],
          "newOwner": {
            "orgId": "641b0eb2623fc30540d70fa7",
            "userId": "6002"
          }
        }
      },
      "owners": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123"
        }
      ],
      "createdAt": "2023-02-15T15:47:00.027Z",
      "createdBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      },
      "updatedAt": "2023-02-17T12:10:24.156Z",
      "updatedBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      }
    }
  ]
}

Get the ownership transfer requests in queue for approval.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request/approvals

Authorization

Query parameters

Response

Ownership transfer request found

Body

countinteger

The number of records returned.

Example: 3

bookmarkstring

The bookmark returned by previous request.

recordsarray of OwnershipTransferResponse (object)

The records returned.

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request/approvals', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "count": 3,
  "bookmark": "text",
  "records": [
    {
      "id": "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134",
      "approvers": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123",
          "status": "PENDING"
        }
      ],
      "numRequired": 1,
      "status": "PENDING",
      "timeout": 60,
      "data": {
        "name": "Flat xyz",
        "address": "Chicago, Illinois",
        "locality": "Harbor Drive",
        "metadata": {
          "assetType": "Property",
          "id": [
            "Prop1"
          ],
          "newOwner": {
            "orgId": "641b0eb2623fc30540d70fa7",
            "userId": "6002"
          }
        }
      },
      "owners": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123"
        }
      ],
      "createdAt": "2023-02-15T15:47:00.027Z",
      "createdBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      },
      "updatedAt": "2023-02-17T12:10:24.156Z",
      "updatedBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      }
    }
  ]
}

Get the ownership transfer requests for a particular asset.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request/byAsset

Authorization

Query parameters

Response

Ownership transfer request found

Body

countinteger

The number of records returned.

Example: 3

bookmarkstring

The bookmark returned by previous request.

recordsarray of OwnershipTransferResponse (object)

The records returned.

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request/byAsset?assetId=false', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "count": 3,
  "bookmark": "text",
  "records": [
    {
      "id": "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134",
      "approvers": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123",
          "status": "PENDING"
        }
      ],
      "numRequired": 1,
      "status": "PENDING",
      "timeout": 60,
      "data": {
        "name": "Flat xyz",
        "address": "Chicago, Illinois",
        "locality": "Harbor Drive",
        "metadata": {
          "assetType": "Property",
          "id": [
            "Prop1"
          ],
          "newOwner": {
            "orgId": "641b0eb2623fc30540d70fa7",
            "userId": "6002"
          }
        }
      },
      "owners": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123"
        }
      ],
      "createdAt": "2023-02-15T15:47:00.027Z",
      "createdBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      },
      "updatedAt": "2023-02-17T12:10:24.156Z",
      "updatedBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      }
    }
  ]
}

Get the ownership transfer requests for a particular asset.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request/history

Authorization

Query parameters

Response

Ownership transfer request found

Body

idstring

Id of the ownership transfer request.

Example: "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134"

countinteger

The number of historical entries returned from the ledger.

Example: 1

recordsarray of object

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset/ownershipTransfer/request/history?id=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134",
  "count": 1,
  "records": [
    {
      "trasactionType": "CREATED",
      "transactionId": "6c94ff55155722c28611630e7d6795145e0282e9fabf10bf3460f396e2a6218b",
      "transactionTime": "2023-02-16T11:55:07.776Z",
      "approvers": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123",
          "status": "PENDING"
        }
      ],
      "numRequired": 1,
      "timeout": 60,
      "status": "PENDING",
      "data": {
        "name": "Flat xyz",
        "address": "Chicago, Illinois",
        "locality": "Harbor Drive",
        "metadata": {
          "assetType": "Property",
          "id": [
            "Prop1"
          ],
          "newOwner": {
            "orgId": "641b0eb2623fc30540d70fa7",
            "userId": "6002"
          }
        }
      },
      "owners": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123"
        }
      ],
      "createdAt": "2023-02-15T15:47:00.027Z",
      "createdBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      },
      "updatedAt": "2023-02-17T12:10:24.156Z",
      "updatedBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      }
    }
  ]
}

Approval

Get approval request by id.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval

Authorization

Query parameters

Response

Approval request found

Body

idstring

Id of the approval request.

Example: "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134"

approversarray of all of

The approver(s) to whom the request was sent for approval.

numRequirednumber

The number of approvers required to approve.

Example: 1

timeoutnumber

The number of minutes after which the approval request should timeout after it has been created.

Example: 60

statusenum

The status of the request

PENDINGAPPROVEDREJECTEDCANCELLED

dataobject

Any additional data that is meaningful to be stored in the approval request.

ownersarray of entity (object)

The owners of the approval request. This is typically same as the approvers.

createdAtstring

Date and time when the approval request was created on the ledger.

Example: "2023-02-15T15:47:00.027Z"

createdByentity (object)

updatedAtstring

Date and time when the approval request was last updated on the ledger.

Example: "2023-02-17T12:10:24.156Z"

updatedByentity (object)

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval?id=text&approvalType=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134",
  "approvers": [
    {
      "orgId": "63c912fd5902d6c20ac43c89",
      "userId": "123",
      "status": "PENDING"
    }
  ],
  "numRequired": 1,
  "timeout": 60,
  "status": "PENDING",
  "data": {
    "name": "Flat xyz",
    "address": "Chicago, Illinois",
    "locality": "Harbor Drive"
  },
  "owners": [
    {
      "orgId": "63c912fd5902d6c20ac43c89",
      "userId": "123"
    }
  ],
  "createdAt": "2023-02-15T15:47:00.027Z",
  "createdBy": {
    "orgId": "63c912fd5902d6c20ac43c89",
    "userId": "123"
  },
  "updatedAt": "2023-02-17T12:10:24.156Z",
  "updatedBy": {
    "orgId": "63c912fd5902d6c20ac43c89",
    "userId": "123"
  }
}

Create a new approval request.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval

Authorization

Query parameters

Body

approvalType*string

A unique name that represents this type of approval. The type is used to distinguish between different types of approvals in the systems. For e.g. LoanRequestApproval and LoanDisbursementApproval can be different approval types in the system. The type is also required while making other Approval API related calls.

Example: "LoanRequestApproval"

approvals*array of object

The Approval request related data. Multiple approvals can be submitted together by providing an array here.

Response

Approval request created.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "approvalType": "LoanRequestApproval",
      "approvals": [
        {
          "approvers": [
            {
              "orgId": "63c912fd5902d6c20ac43c89"
            }
          ]
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Approve the request.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/accept

Authorization

Query parameters

Body

approvalType*string

Example: "LoanRequestApproval"

approvals*array of object

The Approval request related data. Multiple approvals can be submitted together by providing an array here.

Response

Approval request approved.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/accept', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "approvalType": "LoanRequestApproval",
      "approvals": [
        {
          "id": "ea09a7ff705d69eb"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Reject approval request.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/reject

Authorization

Query parameters

Body

approvalType*string

Example: "LoanRequestApproval"

approvals*array of object

The Approval request related data. Multiple approvals can be submitted together by providing an array here.

Response

Approval request rejected.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/reject', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "approvalType": "LoanRequestApproval",
      "approvals": [
        {
          "id": "ea09a7ff705d69eb"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Cancel approval request.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/cancel

Authorization

Query parameters

Body

approvalType*string

Example: "LoanRequestApproval"

approvals*array of object

The Approval request related data. Multiple approvals can be submitted together by providing an array here.

Response

Approval request cancelled.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/cancel', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "approvalType": "LoanRequestApproval",
      "approvals": [
        {
          "id": "ea09a7ff705d69eb"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Get the status of approval requests submitted by an entity.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/my

Authorization

Query parameters

Response

Approval request found

Body

countinteger

The number of records returned.

Example: 3

bookmarkstring

The bookmark returned by previous request.

recordsarray of ApprovalResponse (object)

The records returned.

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/my?approvalType=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "count": 3,
  "bookmark": "text",
  "records": [
    {
      "id": "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134",
      "approvers": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123",
          "status": "PENDING"
        }
      ],
      "numRequired": 1,
      "timeout": 60,
      "status": "PENDING",
      "data": {
        "name": "Flat xyz",
        "address": "Chicago, Illinois",
        "locality": "Harbor Drive"
      },
      "owners": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123"
        }
      ],
      "createdAt": "2023-02-15T15:47:00.027Z",
      "createdBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      },
      "updatedAt": "2023-02-17T12:10:24.156Z",
      "updatedBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      }
    }
  ]
}

Get the approval requests in queue for approval.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/queue

Authorization

Query parameters

Response

Approval request found

Body

countinteger

The number of records returned.

Example: 3

bookmarkstring

The bookmark returned by previous request.

recordsarray of OwnershipTransferResponse (object)

The records returned.

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/queue?approvalType=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "count": 3,
  "bookmark": "text",
  "records": [
    {
      "id": "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134",
      "approvers": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123",
          "status": "PENDING"
        }
      ],
      "numRequired": 1,
      "status": "PENDING",
      "timeout": 60,
      "data": {
        "name": "Flat xyz",
        "address": "Chicago, Illinois",
        "locality": "Harbor Drive",
        "metadata": {
          "assetType": "Property",
          "id": [
            "Prop1"
          ],
          "newOwner": {
            "orgId": "641b0eb2623fc30540d70fa7",
            "userId": "6002"
          }
        }
      },
      "owners": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123"
        }
      ],
      "createdAt": "2023-02-15T15:47:00.027Z",
      "createdBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      },
      "updatedAt": "2023-02-17T12:10:24.156Z",
      "updatedBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      }
    }
  ]
}

Get the approval requests for a particular asset.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/history

Authorization

Query parameters

Response

Approval request found

Body

idstring

Id of the approval request.

Example: "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134"

countinteger

The number of historical entries returned from the ledger.

Example: 1

recordsarray of object

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/approval/history?id=text&approvalType=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "9a7b337324d807e3622c29aad435bf6e6ea1d14a8c4e3850c5627f3be4356d12_124134",
  "count": 1,
  "records": [
    {
      "trasactionType": "CREATED",
      "transactionId": "6c94ff55155722c28611630e7d6795145e0282e9fabf10bf3460f396e2a6218b",
      "transactionTime": "2023-02-16T11:55:07.776Z",
      "approvers": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123",
          "status": "PENDING"
        }
      ],
      "numRequired": 1,
      "timeout": 60,
      "status": "PENDING",
      "data": {
        "name": "Flat xyz",
        "address": "Chicago, Illinois",
        "locality": "Harbor Drive"
      },
      "owners": [
        {
          "orgId": "63c912fd5902d6c20ac43c89",
          "userId": "123"
        }
      ],
      "createdAt": "2023-02-15T15:47:00.027Z",
      "createdBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      },
      "updatedAt": "2023-02-17T12:10:24.156Z",
      "updatedBy": {
        "orgId": "63c912fd5902d6c20ac43c89",
        "userId": "123"
      }
    }
  ]
}

Status check API.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/status

Authorization

Response

Request

const response = await fetch('https://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Tokens

Token APIs allow you to tokenize your assets and issue Non-Fungible Tokens (NFTs) or fungible tokens seamlessly. Tokeniseanything asse you want- real estate, artwork, collectibles, or any other valuable asset. Using these APIs, you can issue, mint, burn tokens. Additionally, user can set approvers for their token account, get balance, view all transactions etc.

Create an asset or a list of assets.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset

Authorization

Query parameters

Body

assetType*string

The type of asset defined in the Asset Tokenization App settings.

Example: "Property"

data*array of object

Custom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.

Response

Asset created.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

Response

Get the properties of an existing token.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token

Authorization

Query parameters

Response

Token found.

Body

docTypestring

docType

Example: "asset"

idstring

Identifier of the token

Example: "RealtyToken"

namestring

name of the token

Example: "RealtyToken"

descriptionstring

Description of the Token

Example: "Token representing fractional ownership in real estate."

symbolstring

Unique symbol for the Token

Example: "RTC"

classificationobject

Contains classification in the scope of fungible or nonfungible with respective unit

behaviourobject

propertiesobject

Additional custom properties for the token.

tokenPermissionsarray of object

Permissions on the Token.

totalSupplyinteger

Total supply of that token

Example: 0

totalMintedAmountinteger

Total quantity of minted tokens

Example: 0

ownersarray of object

owners of that token

createdAtstring

TimeStamp at which created

Example: "2024-01-01T15:30:49.615Z"

updatedAtstring

TimeStamp at which updated

Example: "2024-01-01T15:30:49.615Z"

createdByobject

The user entity object who created the token

updatedByobject

The user entity object who updated the token

Request

Response

Used to create a token type in the blockchain. Multiple token types can be defined within the same blockchain network and users can hold one or more token type. The initialize token method can be used to define a fungible token type or a non-fungible token type (NFT).

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token

Authorization

Query parameters

Body

idstring

The Token id. Should only contain alphabets and numbers. If this is not provided, then an id will be automatically generated

Example: "RealtyToken"

name*string

The display name of the token.

Example: "RealtyToken"

descriptionstring

Description of the token.

Example: "Token representing fractional ownership in real estate."

symbol*string

Symbol of the token.

Example: "RTC"

classification*object

behaviour*object

propertiesobject

Additional custom properties for the token.

tokenPermissions*array of object

Permissions on the Token.

nftFieldsarray of object

Field definitions for a non fungible token. This can be omitted for fungible tokens. A NFT contains additional data that uniquely identifies a minted token. In the data fields, define the primary key that identifies the unique NFT and also any reference fields to other objects on the chain.

Response

Success.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Update the allowed properties of an existing token. Not all fields need to be provided. The provided fileds are partially updated.

PATCHhttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token

Authorization

Query parameters

Body

id*string

Id of the token.

Example: "87be83f3e225f9cc9b03e50b"

descriptionstring

Description of the token.

Example: "Token representing fractional ownership in real estate."

propertiesobject

Additional custom properties for the token.

nftFieldsarray of object

Field definitions for a non fungible token. This can be omitted for fungible tokens.

Response

Token updated.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Get all tokens.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/all

Authorization

Query parameters

Response

Tokens found.

Body

countinteger

The number of records returned from the ledger.

Example: 1

bookmarkstring

The bookmark returned to be submitted in request for next page.

recordsarray of TokenRequest (object)

Tokens returned.

Request

Response

Update the permissions of an existing token.

PATCHhttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/permissions

Authorization

Query parameters

Body

id*string

Id of the token.

Example: "87be83f3e225f9cc9b03e50b"

permissions*array of object

Response

Token permissions updated.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Approve a user/account to manage tokens on behalf of current user. The approved user can managed tokens for specific token Ids mentioned in the request.

PATCHhttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/approval

Authorization

Query parameters

Body

tokenIds*array of string

List of token IDs

operators*array of entity (object)

List of operators

approved*boolean

Indicates whether the tokens are approved or not

Example: true

Response

Token permissions updated.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Update the owners of an existing token.Owners of the token has permissions to update the token properties and permissions. By default when a token is created, the caller becomes the onwer of the token which can be updated using this method.

PATCHhttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/owners

Authorization

Query parameters

Body

id*string

Id of the token.

Example: "87be83f3e225f9cc9b03e50b"

owners*array of entity (object)

Response

Token owners updated.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Mint Fungible or Non-fungible tokens.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/mint

Authorization

Query parameters

Body

id*string

The id of the token to mint.

Example: "87be83f3e225f9cc9b03e50b"

to*object

Organization entity to which tokens are minted

valuenumber

The amount of token to be minted if it is a fungible token. Not required for non-fungible tokens.

Example: 10000

nftDataobject

Any additional data when the token is an NFT. Not required for fungible tokens.

Response

Token minted.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Burn Fungible or Non-fungible tokens.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/burn

Authorization

Query parameters

Body

id*string

The id of the token to mint.

Example: "87be83f3e225f9cc9b03e50b"

from*object

Organization entity from which tokens are burnt.

valuenumber

The amount of token to burn if it is a fungible token. Not required for non-fungible tokens.

Example: 10000

assetIdstring

The Id of the asset to be burned when the token is a NFT. This field is only required when token is non-fungible.

Example: "property2"

Response

Token burned.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Get acount details of the specified Account Id

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/account

Authorization

Query parameters

Response

account found.

Body

idstring

The unique identifier for the account

Example: "account~3bbda18ab9d2677ae28b480d072463d5b6db6c6fc8ec5c95fe4ed59632fbdc9f"

docTypestring

The type of document

Example: "account"

entityentity (object)

tokenIdstring

The token ID associated with the account

Example: "RealtyToken"

balanceinteger

The balance associated with the account

Example: 1

approvedEntitiesarray of entity (object)

List of approved entities

nftIdsarray of string

List of NFT IDs associated with the account

ownersarray of entity (object)

List of owners

createdAtstring (date-time)

The timestamp when the account was created

updatedAtstring (date-time)

The timestamp when the account was last updated

createdByentity (object)

updatedByentity (object)

Request

Response

Get details of all accounts for the specified token Ids.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/account/all

Authorization

Query parameters

Body

tokenIdstring

The token ID

Example: "RealtyToken"

Response

Account found.

Body

idstring

The unique identifier for the account

Example: "account~3bbda18ab9d2677ae28b480d072463d5b6db6c6fc8ec5c95fe4ed59632fbdc9f"

docTypestring

The type of document

Example: "account"

entityentity (object)

tokenIdstring

The token ID associated with the account

Example: "RealtyToken"

balanceinteger

The balance associated with the account

Example: 1

approvedEntitiesarray of entity (object)

List of approved entities

nftIdsarray of string

List of NFT IDs associated with the account

ownersarray of entity (object)

List of owners

createdAtstring (date-time)

The timestamp when the account was created

updatedAtstring (date-time)

The timestamp when the account was last updated

createdByentity (object)

updatedByentity (object)

Request

Response

Get details for specified transaction

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/transaction

Authorization

Query parameters

Response

transaction details found.

Body

docTypestring

The type of document (e.g., "tkntx")

Example: "tkntx"

idstring

The unique identifier for the transaction

Example: "fcfb17c0eb3a73d809ee3d1829cfe157524cb44189f78f8f378c07284bae7f86"

typestring

The type of transaction (e.g., "MINT")

Example: "MINT"

transactionDetailsarray of object

ownersarray of entity (object)

List of owners associated with the transaction

createdAtstring (date-time)

The timestamp when the transaction was created

updatedAtstring (date-time)

The timestamp when the transaction was last updated

createdByentity (object)

updatedByentity (object)

Request

Response

Get details for all transactions for specified Token Ids.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/transaction/all

Authorization

Query parameters

Body

tokenIdstring

The token ID

Example: "RealtyToken"

Response

transaction details found.

Body

docTypestring

The type of document (e.g., "tkntx")

Example: "tkntx"

idstring

The unique identifier for the transaction

Example: "fcfb17c0eb3a73d809ee3d1829cfe157524cb44189f78f8f378c07284bae7f86"

typestring

The type of transaction (e.g., "MINT")

Example: "MINT"

transactionDetailsarray of object

ownersarray of entity (object)

List of owners associated with the transaction

createdAtstring (date-time)

The timestamp when the transaction was created

updatedAtstring (date-time)

The timestamp when the transaction was last updated

createdByentity (object)

updatedByentity (object)

Request

Response

ERC1155

ERC1155 is a popular token standard in the blockchain industry that allows for the creation and management of both fungible and non-fungible tokens. It provides a flexible and efficient way to represent multiple token types within a single smart contract.

Create an asset or a list of assets.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset

Authorization

Query parameters

Body

assetType*string

The type of asset defined in the Asset Tokenization App settings.

Example: "Property"

data*array of object

Custom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.

Response

Asset created.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

Response

Get token balance for a particular user/account.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/erc1155/balanceOf

Authorization

Query parameters

Body

id*string

The id of the token to retrieve.

Example: "87be83f3e225f9cc9b03e50b"

owner*object

Response

Token balance retrieved.

Body

ownerentity (object)

balanceinteger

value of the balance

Example: 2

Request

Response

Get token balance for multiple user/account.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/erc1155/balanceOfBatch

Authorization

Query parameters

Body

ids*array of string

owners*object

Response

Token balance retrieved.

Body

ownerobject

balanceinteger

Example: 10

Request

Response

Approve a user/account to manage tokens on behalf of current user. The approved user can managed all tokens that belong to the target user.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/erc1155/setApprovalForAll

Authorization

Query parameters

Body

approved*boolean

Whether to approve or revoke.

Example: true

operator*object

Organization entity whom caller is approving.

Response

Token Approval succeeded.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Check if a user/account can manage tokens on behalf of current user.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/erc1155/isApprovedForAll

Authorization

Query parameters

Body

owner*object

Organization who approved a operator.

operator*object

Organization who got approved by a owner.

Response

Token Approval succeeded.

Body

approvedboolean

returs true if approved or false if not

Example: "true"

Request

Response

Transfer token from one account to another account.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/erc1155/safeTransferFrom

Authorization

Query parameters

Body

from*object

The account or organizational entity from which tokens needs to be transfered.

to*object

The account or organizational entity to which tokens needs to be transfered.

id*string

Identity of the token e.g RealtyToken.

Example: "RealtyToken"

value*number

Number of token to be transferred. It is 1 in case of non fungible and maximum total supply in case of fungible.

Example: 100

dataobject

This is field is required in case of non-fungible. Which should have assetId of the non-fungible token Id. e.g Property1 of RealtyToken

Response

Token transfer succeeded.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Transfer token from one account to another in batch.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/erc1155/safeBatchTransferFrom

Authorization

Query parameters

Body

from*object

The account or organizational entity from which tokens needs to be transfered.

to*object

The account or organizational entity to which tokens needs to be transfered.

ids*array of string

Identity of the token e.g RealtyToken.

values*array of number

Number of token to be transferred. It is 1 in case of non fungible and maximum total supply in case of fungible.

dataobject

This is field is required in case of non-fungible. Which should have assetId of the non-fungible token Id. e.g Property1 of RealtyToken

Response

Token transfer succeeded.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Vault

Vault is a mechanism for fractionalisation that allows for the division of assets into smaller, more manageable fractions. This concept is particularly relevant in the world of finance and investment, where it enables the creation of new investment opportunities and increased liquidity.

A custodian is a trusted party responsible for safeguarding and managing the assets held within the vault. A custodian can deposit or withdraw assets from a vault.

Create an asset or a list of assets.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/asset

Authorization

Query parameters

Body

assetType*string

The type of asset defined in the Asset Tokenization App settings.

Example: "Property"

data*array of object

Custom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.

Response

Asset created.

Body

transactionIdstring

The transaction id generated by the Blockchain ledger.

Example: "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2"

receiptId*string

The request Id for this API request. This id can be used later to query the status of a transaction anytime using the /asset/receipt endpoint.

Example: "643d316fa27b8c7dcdb31c49"

Request

Response

Get the properties of an existing vault.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/vault

Authorization

Query parameters

Response

Vault found.

Body

id*string

Unique identifier of the vault

Example: "RealEstateVault"

name*string

The name of the vault.

Example: "Real Estate Vault"

descriptionstring

Vault used to hold real estate assets.

Example: "Real Estate Vault"

custodiansarray of object

dataobject

Any additiona Json data to be added as properties of the Vault.

vaultTokenIdarray of string

Identifier of the tokens associated with the vault.

ownersarray of object

createdAtstring

Timestamp at which doc is created

Example: "2024-01-02T11:43:07.17Z"

updatedAtstring

Timestamp at which doc is updated

Example: "2024-01-02T11:43:07.17Z"

createdByobject

org entity which doc is created

updatedByobject

org entity which doc is updated

Request

Response

Used to initialize a vault and define the fungible tokens associated with the vault.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/vault

Authorization

Query parameters

Body

idstring

Unique identifier of the vault. This is not mandatory. If not provided a unique id will be automatically generated.

Example: "RealEstateVault"

name*string

The display name of the vault.

Example: "Real Estate Vault"

descriptionstring

Description of the Vault.

Example: "Vault used to hold real estate assets"

custodiansarray of object

Array of custodians for the vault. Custodians have the ability manage the vault properties and also the asset related properties - like asset value, metadata etc. If this field is not provided, current caller is added as custodian.

dataobject

Any additiona Json data to be added as properties of the Vault. This usually represents additional information about the assets that will be deposited in the vault.

vaultTokenarray of InitializeVaultTokenRequest (object)

The tokens associated with the vault. These tokens are used to represent fractions of assets that are deposited in the vault. Multiple tokens can be associated with the vault which represents multiple class of shares that are issued against an asset.

Response

Vault created.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Update the allowed properties of an existing vault.

PATCHhttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/vault

Authorization

Query parameters

Body

idstring

Example: "56be83f3e225f9cc9b03e50b"

namestring

Example: "Real Estate Vault"

descriptionstring

Example: "Vault used to hold real estate assets"

dataobject

Any additiona Json data to be added as properties of the Vault.

Response

Vault updated.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Get all vaults to which caller can access to.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/vault/all

Authorization

Query parameters

Response

Vaults found.

Body

id*string

Unique identifier of the vault

Example: "RealEstateVault"

name*string

The name of the vault.

Example: "Real Estate Vault"

descriptionstring

Vault used to hold real estate assets.

Example: "Real Estate Vault"

custodiansarray of object

dataobject

Any additiona Json data to be added as properties of the Vault.

vaultTokenIdarray of string

Identifier of the tokens associated with the vault.

ownersarray of object

createdAtstring

Timestamp at which doc is created

Example: "2024-01-02T11:43:07.17Z"

updatedAtstring

Timestamp at which doc is updated

Example: "2024-01-02T11:43:07.17Z"

createdByobject

org entity which doc is created

updatedByobject

org entity which doc is updated

Request

Response

Create a new fungible token and associate it with an existing vault.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/vault/addToken

Authorization

Query parameters

Body

id*string

Unique identifier of the vault.

Example: "RealEstateVault"

vaultToken*array of InitializeVaultTokenRequest (object)

The tokens to be created in order to associate with the vault. These tokens are used to represent fractions of assets that are deposited in the vault. Multiple tokens can be associated with the vault which represents multiple class of shares that are issued against an asset.

Response

Vault created.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Associate an existing token with an existing vault.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/vault/addToken/existing

Authorization

Query parameters

Body

id*string

Unique identifier of the vault.

Example: "RealEstateVault"

tokenId*array of string

The Ids of existing tokens to be associated with the vault. The token should be of type fungible, with classification.vauleType = reference. Also, the vault custodians should have mint and burn permissions on the tokens to be associated. These tokens are used to represent fractions of assets that are deposited in the vault. Multiple tokens can be associated with the vault which represents multiple class of shares that are issued against an asset.

Response

Vault created.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Update the custodian of a vault

PATCHhttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/vault/custodians

Authorization

Query parameters

Body

vaultId*string

Existing vault Id to which custodians need to be updated.

Example: "testVault"

custodians*array of entity (object)

Array of the new custodian entities. The existing custodians will be replaced with the provided value.

Response

Update Custodians for the specified vault is successful.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Deposit Assets to the vault and mint corresponding fungible tokens to the reciever's account.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/vault/deposit

Authorization

Query parameters

Body

vaultId*string

Unique vault Id to which asset is to be deposited.

Example: "RealEstateVault"

assets*array of object

List of assets to be deposited.

Response

Deposit Assets succeeded.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Withdraw Assets from the vault and burn corresponding fungible tokens from the payer's account.

POSThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/vault/withdraw

Authorization

Query parameters

Body

vaultId*string

Existing VaultId from which assets need to be withdrawn.

Example: "RealEstateVault"

assets*array of object

List of assets to withdraw.

Response

Withdraw Assets succeeded.

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Get all the assets that have been deposited in the specified Vault.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/vault/assets

Authorization

Query parameters

Response

Vault assets found.

Body

countnumber

Example: 2

assetsarray of object

Request

Response

Update the allowed values of asset inside specified vault. This is used to update the value of an asset in the vault or update an additional metadata associated with the vault.

PATCHhttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/token/vault/assets

Authorization

Query parameters

Body

vaultId*string

Existing vault Id.

Example: "RealEstateVault"

assets*array of object

Response

Update Successful

Body

transactionIdstring

Transaction id of the blockchain transaction.

Example: "e3e4b0f0376f550724bd7fe79a969d0bbb48f6b2b866f584b2a44007a294c411"

receiptIdstring

The receipt id returned while submitting the transaction.

Example: "6592daa9a4f85cb8fbda042a"

Request

Response

Status check API.

GEThttps://<networkorgid>.<publicdomain>/tokenize/<chaincodeccid>/status

Authorization

Response

Request

PreviousAsset Tokenization NextTesting REST API

Last updated 9 months ago