REST API
Last updated
Was this helpful?
Last updated
Was this helpful?
You can access the Rest API through the Swagger UI from the App API section. Navigate to Network -> Deployed Apps -> App -> Rest API
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.
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.
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.
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.
Query an asset.
The type of asset defined in the Asset Tokenization App settings.
Id of the asset. This is the Id that is maintained in your system and corresponds to value of the Primary Key attribute defined in the Asset Tokenization App settings.
For referenced objects, depth up to which references to be returned. For e.g. if depth=1, one level of references will be resolved.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get the asset along with history of changes.
The type of asset defined in the Asset Tokenization App settings.
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.
For referenced objects, depth up to which references to be returned.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get all assets.
The type of asset defined in the Asset Tokenization App settings.
The number of records to be returned in a page. The default is 25.
The bookmark returned by previous request.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get the status of an already submitted transaction using the returned receipt id.
The receipt id returned while submitting the transaction.
Get statistics about asset usage.
Get ownership transfer request by id.
Id of the ownership approval request.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get the status of ownership transfer requests submitted by an entity.
The number of records to be returned in a page. The default is 25.
The bookmark returned by previous request.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get the ownership transfer requests in queue for approval.
Get only pending requests. The default is true.
The number of records to be returned in a page. The default is 25.
The bookmark returned by previous request.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get the ownership transfer requests for a particular asset.
The Id of the asset for which ownership transfer requests need to be fetched.
Get only pending requests. The default is true.
The number of records to be returned in a page. The default is 25.
The bookmark returned by previous request.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get the ownership transfer requests for a particular asset.
Id of the ownership approval request.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get approval request by id.
Id of the approval request.
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
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get the status of approval requests submitted by an entity.
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
The number of records to be returned in a page. The default is 25.
The bookmark returned by previous request.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get the approval requests in queue for approval.
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
Get only pending requests. The default is true.
The number of records to be returned in a page. The default is 25.
The bookmark returned by previous request.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get the approval requests for a particular asset.
Id of the approval request.
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
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Status check API.
OK
No content
Create an asset or a list of assets.
Whether to wait for the asset to be created before returning a response or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The type of asset defined in the Asset Tokenization App settings.
PropertyCustom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.
{"id":"Prop1","name":"Flat xyz","address":"Chicago, Illinois","locality":"Harbor Drive"}Create or update an asset or a list of assets. If an asset with the same id exists, the existing asset will be updated.
Whether to wait for the asset to be created before returning a response or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The type of asset defined in the Asset Tokenization App settings.
PropertyCustom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.
{"id":"Prop1","name":"Flat xyz","address":"Chicago, Illinois","locality":"Harbor Drive"}Delete one or more assets.
Whether to wait for the asset to be deleted before returning or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The type of asset defined in the Asset Tokenization App settings.
PropertyId 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.
Prop1Update an asset or a list of assets.
Whether to wait for the asset to be updated before returning or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The type of asset defined in the Asset Tokenization App settings.
PropertyCustom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.
{"id":"Prop1","name":"Flat xyz","address":"Chicago, Illinois","locality":"Harbor Drive"}Update owners of an asset. This method replaces the current owners with the new owner array provided.
Whether to wait for the asset to be updated before returning or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The type of asset defined in the Asset Tokenization App settings.
PropertyRequest ownership of an asset to be transferred.
Whether to wait for the asset to be updated before returning or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The type of asset defined in the Asset Tokenization App settings.
PropertyApprove ownership transfer request.
Whether to wait for the asset to be updated before returning or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Id of the approval request. You can approve multiple ownership transfer requests together by providing an array of Ids here.
641821e82c44573cb52c7d97Reject ownership transfer request.
Whether to wait for the asset to be updated before returning or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Id of the approval request. You can approve multiple ownership transfer requests together by providing an array of Ids here.
641821e82c44573cb52c7d97Create a new approval request.
Whether to wait for the asset to be updated before returning or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
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.
LoanRequestApprovalApprove the request.
Whether to wait for the asset to be updated before returning or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
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.
LoanRequestApprovalReject approval request.
Whether to wait for the asset to be updated before returning or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
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.
LoanRequestApprovalCancel approval request.
Whether to wait for the asset to be updated before returning or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
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.
LoanRequestApprovalGet the properties of an existing token.
The id of the token to query for.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get all tokens.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Tokens found.
Get acount details of the specified Account Id
The id of the account to query for.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get details for specified transaction
The id of the transaction to query for.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get the properties of an existing vault.
The id of the vault to query for.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Get all vaults to which caller can access to.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Vaults found.
Get all the assets that have been deposited in the specified Vault.
The id of the vault to query for.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Status check API.
OK
No content
Create an asset or a list of assets.
Whether to wait for the asset to be created before returning a response or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The type of asset defined in the Asset Tokenization App settings.
PropertyCustom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.
{"id":"Prop1","name":"Flat xyz","address":"Chicago, Illinois","locality":"Harbor Drive"}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).
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The Token id. Should only contain alphabets and numbers. If this is not provided, then an id will be automatically generated
RealtyTokenThe display name of the token.
RealtyTokenDescription of the token.
Token representing fractional ownership in real estate.Symbol of the token.
RTCAdditional custom properties for the token.
{"currency":"USD","value":1}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.
{"name":"id","desc":"The primary key field of the NFT that represents the id of the NFT","isPrimaryKey":true,"isForeignKey":false}Update the allowed properties of an existing token. Not all fields need to be provided. The provided fileds are partially updated.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Id of the token.
87be83f3e225f9cc9b03e50bDescription of the token.
Token representing fractional ownership in real estate.Additional custom properties for the token.
{"currency":"USD","value":1}Field definitions for a non fungible token. This can be omitted for fungible tokens.
{"name":"id","desc":"The primary key field of the NFT that represents the id of the NFT","isPrimaryKey":true,"isForeignKey":false}Update the permissions of an existing token.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Id of the token.
87be83f3e225f9cc9b03e50bApprove 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.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
List of token IDs
["RealtyToken"]Indicates whether the tokens are approved or not
trueUpdate 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.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Id of the token.
87be83f3e225f9cc9b03e50bMint Fungible or Non-fungible tokens.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The id of the token to mint.
87be83f3e225f9cc9b03e50bOrganization entity to which tokens are minted
{"orgId":"64be83f3e225f9cc9b03e50b","userId":"1234"}The amount of token to be minted if it is a fungible token. Not required for non-fungible tokens.
10000Any additional data when the token is an NFT. Not required for fungible tokens.
{"id":"property1","name":"Flat xyz","address":"Chicago, Illinois","locality":"Harbor Drive"}Burn Fungible or Non-fungible tokens.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The id of the token to mint.
87be83f3e225f9cc9b03e50bOrganization entity from which tokens are burnt.
{"orgId":"64be83f3e225f9cc9b03e50b","userId":"1234"}The amount of token to burn if it is a fungible token. Not required for non-fungible tokens.
10000The Id of the asset to be burned when the token is a NFT. This field is only required when token is non-fungible.
property2Get details of all accounts for the specified token Ids.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The token ID
RealtyTokenGet details for all transactions for specified Token Ids.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The token ID
RealtyTokenCreate an asset or a list of assets.
Whether to wait for the asset to be created before returning a response or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The type of asset defined in the Asset Tokenization App settings.
PropertyCustom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.
{"id":"Prop1","name":"Flat xyz","address":"Chicago, Illinois","locality":"Harbor Drive"}Get token balance for a particular user/account.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The id of the token to retrieve.
87be83f3e225f9cc9b03e50b{"orgId":"64be83f3e225f9cc9b03e50b","userId":"1234"}Get token balance for multiple user/account.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The ids of the token to retrieve.
sampletoken1, sampletoken2[{"orgId":"64be83f3e225f9cc9b03e50b","userId":"1234"},{"orgId":"6592bf712aca6650dc152911","userId":"1234"}]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.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Whether to approve or revoke.
trueOrganization entity whom caller is approving.
{"orgId":"64be83f3e225f9cc9b03e50b","userId":"1234"}Check if a user/account can manage tokens on behalf of current user.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Organization who approved a operator.
{"orgId":"64be83f3e225f9cc9b03e50b","userId":"9876"}Organization who got approved by a owner.
{"orgId":"64be83f3e225f9cc9b03e50b","userId":"1234"}Transfer token from one account to another account.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The account or organizational entity from which tokens needs to be transfered.
{"orgId":"64be83f3e225f9cc9b03e50b","userId":"9876"}The account or organizational entity to which tokens needs to be transfered.
{"orgId":"64be83f3e225f9cc9b03e50b","userId":"1234"}Identity of the token e.g RealtyToken.
RealtyTokenNumber of token to be transferred. It is 1 in case of non fungible and maximum total supply in case of fungible.
100This is field is required in case of non-fungible. Which should have assetId of the non-fungible token Id. e.g Property1 of RealtyToken
{"assetId":"property1"}Transfer token from one account to another in batch.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
The account or organizational entity from which tokens needs to be transfered.
{"orgId":"64be83f3e225f9cc9b03e50b","userId":"9876"}The account or organizational entity to which tokens needs to be transfered.
{"orgId":"64be83f3e225f9cc9b03e50b","userId":"1234"}Identity of the token e.g RealtyToken.
'nft1', 'nft2'Number of token to be transferred. It is 1 in case of non fungible and maximum total supply in case of fungible.
100This is field is required in case of non-fungible. Which should have assetId of the non-fungible token Id. e.g Property1 of RealtyToken
{"assetIds":["property1","property2"]}Create an asset or a list of assets.
Whether to wait for the asset to be created before returning a response or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /asset/receipt endpoint.
The type of asset defined in the Asset Tokenization App settings.
PropertyCustom JSON object representing an asset. You can submit a single asset or multiple assets in one request by providing an array of assets here.
{"id":"Prop1","name":"Flat xyz","address":"Chicago, Illinois","locality":"Harbor Drive"}Used to initialize a vault and define the fungible tokens associated with the vault.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Unique identifier of the vault. This is not mandatory. If not provided a unique id will be automatically generated.
RealEstateVaultThe display name of the vault.
Real Estate VaultDescription of the Vault.
Vault used to hold real estate assetsArray 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.
{"orgId":"64be83f3e225f9cc9b03e50b","userId":"custodian1"}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.
{"project":"Sapphire","location":"Chicago"}Update the allowed properties of an existing vault.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
56be83f3e225f9cc9b03e50bReal Estate VaultVault used to hold real estate assetsAny additiona Json data to be added as properties of the Vault.
{"meta":"data"}Create a new fungible token and associate it with an existing vault.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Unique identifier of the vault.
RealEstateVaultAssociate an existing token with an existing vault.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Unique identifier of the vault.
RealEstateVaultThe 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.
RealEstateTokenUpdate the custodian of a vault
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Existing vault Id to which custodians need to be updated.
testVaultDeposit Assets to the vault and mint corresponding fungible tokens to the reciever's account.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Unique vault Id to which asset is to be deposited.
RealEstateVaultWithdraw Assets from the vault and burn corresponding fungible tokens from the payer's account.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Existing VaultId from which assets need to be withdrawn.
RealEstateVaultUpdate 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.
The entity (like user, suborg etc) within the org on behalf of which the request is being made.
Example: userId:123
Existing vault Id.
RealEstateVault