Tokenized Deposit Application Wrapper APIs

All REST Endpoints

Account Contract

Activate Account: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/activateAccount
Add Account Role: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/addRole
Add Organization Admin: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/addOrgAdmin
Add Organization Auditor: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/addOrgAuditor
Add Token Admin: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/addTokenAdmin
Add Token Auditor: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/addTokenAuditor
Check Account Deployment Status: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/isDeploymentActive
Check Account Role: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/isInRole
Check Account Status: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/isActive
Check Organization Admin: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/isOrgAdmin
Check Organization Auditor: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/isOrgAuditor
Check Token Admin: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/isTokenAdmin
Check Token Auditor: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/isTokenAuditor
Create Account: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/createAccount
Delete Account: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/deleteAccount
Get Account by Address: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/getAccountByAddress
Get Account Context: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/getContext
Get Account Contract Version: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/version
Get Account Governance Context: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/getGovernanceContext
Get Account Group ID: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/getGroupId
Get Account Identity: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/getIdentity
Get All Accounts: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/getAllAccounts
Get All Organization Admins: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/getAllOrgAdmins
Get All Organization Auditors: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/getAllOrgAuditors
Get All Token Admins: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/getAllTokenAdmins
Get All Token Auditors: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/getAllTokenAuditors
Get Smart Account Status: Method: get
Path: {baseUrl}/v1/{accountContractAddress}/getAccountStatus
Remove Account Role: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/removeRole
Remove Organization Admin: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/removeOrgAdmin
Remove Organization Auditor: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/removeOrgAuditor
Remove Token Admin: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/removeTokenAdmin
Remove Token Auditor: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/removeTokenAuditor
Renounce Named Role: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/renounceNamedRole
Set Account Context: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/setContext
Set Account Governance Context: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/setGovernanceContext
Set Maximum Daily Amount: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/setMaxDailyAmount
Set Maximum Daily Transaction Count: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/setMaxDailyTransactionCount
Suspend Account: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/suspendAccount

Combined APIs

Create Account with Role: Method: post
Path: {baseUrl}/v1/{accountContractAddress}/createAccountWithRole

ORDS

Get Account History (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenAccountHistory
Get Account History (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenAccountHistory
Get Account Policies (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenAccountPolicies
Get Account Policies (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenAccountPolicies
Get Account Policy History (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenAccountPolicyHistory
Get Account Policy History (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenAccountPolicyHistory
Get Account Roles (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenRolesByAccount
Get Account Roles (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenRolesByAccount
Get Account Status (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenAccountStatus
Get Account Status (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenAccountStatus
Get Account Status History (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenAccountStatusHistory
Get Account Status History (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenAccountStatusHistory
Get Account Transaction History (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenAccountTransactionHistory
Get Account Transaction History (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenAccountTransactionHistory
Get Accounts by Role (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenAccountsByRole
Get Accounts by Role (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenAccountsByRole
Get Accounts by User (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenAccountsByUser
Get Accounts by User (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenAccountsByUser
Get Active Token Accounts (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllActiveDepositTokenAccounts
Get Active Token Accounts (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getAllActiveDepositTokenAccounts
Get All Account Transaction History (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllDepositTokenAccountTransactionHistory
Get All Account Transaction History (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getAllDepositTokenAccountTransactionHistory
Get Approval Policies (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenApprovalPolicies
Get Approval Policies (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenApprovalPolicies
Get Approval Policy History (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenApprovalPolicyHistory
Get Approval Policy History (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenApprovalPolicyHistory
Get Approval Status (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenApprovalStatusByOperationId
Get Approval Status (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenApprovalStatusByOperationId
Get Approvals by Approver (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenApprovalsByApprover
Get Approvals by Approver (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenApprovalsByApprover
Get Approvals by Operation ID (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenApprovalsByOperationId
Get Approvals by Operation ID (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenApprovalsByOperationId
Get Approver Action History (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenApproverActionHistory
Get Approver Action History (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenApproverActionHistory
Get Organization Accounts (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenOrganizationAccounts
Get Organization Accounts (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenOrganizationAccounts
Get Organization Accounts by Role (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenOrganizationAccountsByRole
Get Organization Accounts by Role (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenOrganizationAccountsByRole
Get Pending Approval Operations (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getPendingDepositTokenApprovalOperations
Get Pending Approval Operations (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getPendingDepositTokenApprovalOperations
Get Pending Request (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getPendingRequest
Get Pending Request (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getPendingRequest
Get Pending Token Issuance (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getPendingDepositTokenIssuance
Get Pending Token Issuance (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getPendingDepositTokenIssuance
Get Pending Token Request (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getPendingDepositTokenRequest
Get Pending Token Request (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getPendingDepositTokenRequest
Get Retired Quantity (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenRetiredQuantity
Get Retired Quantity (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenRetiredQuantity
Get Suspended Token Accounts (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllSuspendedDepositTokenAccounts
Get Suspended Token Accounts (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getAllSuspendedDepositTokenAccounts
Get Token Accounts (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllDepositTokenAccounts
Get Token Accounts (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getAllDepositTokenAccounts
Get Token History (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenHistory
Get Token History (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenHistory
Get Token Metadata (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenMetadata
Get Token Metadata (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenMetadata
Get Token Organizations (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getAllDepositTokenOrganizations
Get Token Organizations (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getAllDepositTokenOrganizations
Get Transaction by ID (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenTransactionById
Get Transaction by ID (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenTransactionById
Get Users by Role (Generic Contract): Method: get
Path: {baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getDepositTokenUsersByRole
Get Users by Role (Tokenized Contract): Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/{ordsPathPrefix}/getDepositTokenUsersByRole

Schema Registration

Get Registered Endpoints: Method: get
Path: {baseUrl}/v1/register
Patch Account Endpoints: Method: patch
Path: {baseUrl}/v1/register/{accountContractAddress}
Patch Tokenized Contract Endpoints: Method: patch
Path: {baseUrl}/v1/register/{tokenizedDepositContractAddress}
Register Account Endpoints: Method: post
Path: {baseUrl}/v1/register

Tokenized Deposit Contract

Approve Burn Request: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/approveBurn
Approve Mint Request: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/approveMint
Approve Token Allowance: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/approve
Approve Transaction: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/approveTransaction
Batch Transfer Tokens: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/batchTransfer
Burn Tokens from Account: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/burnFrom
Check Tokenized Deployment Status: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/isDeploymentActive
Create or Update Account Policy: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/createOrupdateAccountPolicy
Create or Update Approval Policy: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/createOrupdateApprovalPolicy
Delete Account Policy: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/deleteAccountPolicy
Delete Approval Policy: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/deleteApprovalPolicy
Execute Token Hold: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/executeHold
Get Account Hold Balance: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getAccountOnHoldBalance
Get Account Policy: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getAccountPolicyById
Get Account Policy ID: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getAccountPolicyIdForAddress
Get Allowance: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/allowance
Get Approval Policy: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getApprovalPolicyById
Get Approval Transactions: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getApprovalTransactionsById
Get Hold Balance: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getOnHoldBalanceWithOperationId
Get Hold Details: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getOnHoldDetailsWithOperationId
Get Pause Status: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/paused
Get Token: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getToken
Get Token Approval Status: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getApprovalStatusByOperationId
Get Token Balance: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/balanceOf
Get Token Context: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getTokenContext
Get Token Decimals: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/decimals
Get Token Name: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/name
Get Token Supply Cap: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/cap
Get Token Symbol: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/symbol
Get Tokenized Contract Version: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/version
Get Tokenized Governance Context: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getGovernanceContext
Get Total Supply: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/totalSupply
Get Transfer Restrictions: Method: get
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/getTransferRestriction
Initialize Deposit Token: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/initializeDepositToken
Pause Token: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/pause
Place Account Token Hold: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/holdFrom
Place Token Hold: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/hold
Reject Burn Request: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/rejectBurn
Reject Mint Request: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/rejectMint
Reject Transaction: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/rejectTransaction
Release Token Hold: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/releaseHold
Request Token Burn: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/requestBurn
Request Token Mint: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/requestMint
Resume Token Operations: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/unpause
Set or Update Transfer Restrictions: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/setOrupdateTransferRestriction
Set Token Context: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/setTokenContext
Set Tokenized Governance Context: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/setGovernanceContext
Transfer Tokens: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/transfer
Transfer Tokens from Account: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/transferFrom
Update Hold Notary: Method: post
Path: {baseUrl}/v1/{tokenizedDepositContractAddress}/updateNotary

UWaaS

Create Organization: Method: post
Path: {baseUrl}/v1/uwaas/orgs
Create Wallet: Method: post
Path: {baseUrl}/v1/uwaas/wallets/provision
createOrganizationNetworks: Method: post
Path: {baseUrl}/v1/uwaas/orgs/{orgId}/organization-networks
Get Organizations: Method: get
Path: {baseUrl}/v1/uwaas/orgs
Get Wallets: Method: get
Path: {baseUrl}/v1/uwaas/wallets
Update Organization: Method: put
Path: {baseUrl}/v1/uwaas/orgs/{orgId}