# Tokens ## Return a list of tokens. > Returns all tokens. For the Standard Registry role it returns only the list of tokens, for other users it also returns token balances as well as the KYC, Freeze, and Association statuses. Not allowed for the Auditor role. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token ID (assigned after token creation on Hedera)"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"initialSupply":{"type":"string","description":"Initial supply of the token (set to 0 for mintable tokens)"},"decimals":{"type":"string","description":"Number of decimal places (0 for NFTs, typically 2 for fungible tokens)"},"changeSupply":{"type":"boolean","description":"Enable Supply key — allows minting and burning tokens"},"enableAdmin":{"type":"boolean","description":"Enable Admin key — allows managing token properties"},"enableFreeze":{"type":"boolean","description":"Enable Freeze key — allows freezing token transfers for specific accounts"},"enableKYC":{"type":"boolean","description":"Enable KYC key — allows granting/revoking KYC status for accounts"},"enableWipe":{"type":"boolean","description":"Enable Wipe key — allows wiping token balance from specific accounts"}},"required":["tokenId","tokenName","tokenSymbol","tokenType","initialSupply","decimals","changeSupply","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens":{"get":{"description":"Returns all tokens. For the Standard Registry role it returns only the list of tokens, for other users it also returns token balances as well as the KYC, Freeze, and Association statuses. Not allowed for the Auditor role.","operationId":"TokensApi_getTokensV2_2","parameters":[{"name":"policyId","required":false,"in":"query","description":"Policy Id","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","description":"Token status","schema":{"enum":["Associated","All"],"type":"string"}},{"name":"pageIndex","required":false,"in":"query","description":"The number of pages to skip before starting to collect the result set","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"The numbers of items to return","schema":{"type":"number"}}],"responses":{"200":{"description":"Successful operation.","headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"Total items in the collection."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TokenDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a list of tokens.","tags":["tokens"]}}}} ``` ## Creates a new token. > Creates a new token. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token ID (assigned after token creation on Hedera)"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"initialSupply":{"type":"string","description":"Initial supply of the token (set to 0 for mintable tokens)"},"decimals":{"type":"string","description":"Number of decimal places (0 for NFTs, typically 2 for fungible tokens)"},"changeSupply":{"type":"boolean","description":"Enable Supply key — allows minting and burning tokens"},"enableAdmin":{"type":"boolean","description":"Enable Admin key — allows managing token properties"},"enableFreeze":{"type":"boolean","description":"Enable Freeze key — allows freezing token transfers for specific accounts"},"enableKYC":{"type":"boolean","description":"Enable KYC key — allows granting/revoking KYC status for accounts"},"enableWipe":{"type":"boolean","description":"Enable Wipe key — allows wiping token balance from specific accounts"}},"required":["tokenId","tokenName","tokenSymbol","tokenType","initialSupply","decimals","changeSupply","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens":{"post":{"description":"Creates a new token. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_newToken","parameters":[],"requestBody":{"required":true,"description":"Object that contains token information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDTO"}}}},"responses":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TokenDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Creates a new token.","tags":["tokens"]}}}} ``` ## Update token. > Update token. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token ID (assigned after token creation on Hedera)"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"initialSupply":{"type":"string","description":"Initial supply of the token (set to 0 for mintable tokens)"},"decimals":{"type":"string","description":"Number of decimal places (0 for NFTs, typically 2 for fungible tokens)"},"changeSupply":{"type":"boolean","description":"Enable Supply key — allows minting and burning tokens"},"enableAdmin":{"type":"boolean","description":"Enable Admin key — allows managing token properties"},"enableFreeze":{"type":"boolean","description":"Enable Freeze key — allows freezing token transfers for specific accounts"},"enableKYC":{"type":"boolean","description":"Enable KYC key — allows granting/revoking KYC status for accounts"},"enableWipe":{"type":"boolean","description":"Enable Wipe key — allows wiping token balance from specific accounts"}},"required":["tokenId","tokenName","tokenSymbol","tokenType","initialSupply","decimals","changeSupply","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens":{"put":{"description":"Update token. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_updateToken","parameters":[],"requestBody":{"required":true,"description":"Object that contains token information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDTO"}}}},"responses":{"201":{"description":"Updated token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden.\n\nForbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Update token.","tags":["tokens"]}}}} ``` ## Return a token by id. > Return the token. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token ID (assigned after token creation on Hedera)"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"initialSupply":{"type":"string","description":"Initial supply of the token (set to 0 for mintable tokens)"},"decimals":{"type":"string","description":"Number of decimal places (0 for NFTs, typically 2 for fungible tokens)"},"changeSupply":{"type":"boolean","description":"Enable Supply key — allows minting and burning tokens"},"enableAdmin":{"type":"boolean","description":"Enable Admin key — allows managing token properties"},"enableFreeze":{"type":"boolean","description":"Enable Freeze key — allows freezing token transfers for specific accounts"},"enableKYC":{"type":"boolean","description":"Enable KYC key — allows granting/revoking KYC status for accounts"},"enableWipe":{"type":"boolean","description":"Enable Wipe key — allows wiping token balance from specific accounts"}},"required":["tokenId","tokenName","tokenSymbol","tokenType","initialSupply","decimals","changeSupply","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}":{"get":{"description":"Return the token.","operationId":"TokensApi_getTokenByIdWithPolicies","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token identifier","schema":{"type":"string"}},{"name":"policyId","required":false,"in":"query","description":"Optional policy ID to filter linked policies in response","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a token by id.","tags":["tokens"]}}}} ``` ## Creates a new token. > Creates a new token. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token ID (assigned after token creation on Hedera)"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"initialSupply":{"type":"string","description":"Initial supply of the token (set to 0 for mintable tokens)"},"decimals":{"type":"string","description":"Number of decimal places (0 for NFTs, typically 2 for fungible tokens)"},"changeSupply":{"type":"boolean","description":"Enable Supply key — allows minting and burning tokens"},"enableAdmin":{"type":"boolean","description":"Enable Admin key — allows managing token properties"},"enableFreeze":{"type":"boolean","description":"Enable Freeze key — allows freezing token transfers for specific accounts"},"enableKYC":{"type":"boolean","description":"Enable KYC key — allows granting/revoking KYC status for accounts"},"enableWipe":{"type":"boolean","description":"Enable Wipe key — allows wiping token balance from specific accounts"}},"required":["tokenId","tokenName","tokenSymbol","tokenType","initialSupply","decimals","changeSupply","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push":{"post":{"description":"Creates a new token. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_pushTokenAsync","parameters":[],"requestBody":{"required":true,"description":"Object that contains token information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDTO"}}}},"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Creates a new token.","tags":["tokens"]}}}} ``` ## Update token. > Update token. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token ID (assigned after token creation on Hedera)"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"initialSupply":{"type":"string","description":"Initial supply of the token (set to 0 for mintable tokens)"},"decimals":{"type":"string","description":"Number of decimal places (0 for NFTs, typically 2 for fungible tokens)"},"changeSupply":{"type":"boolean","description":"Enable Supply key — allows minting and burning tokens"},"enableAdmin":{"type":"boolean","description":"Enable Admin key — allows managing token properties"},"enableFreeze":{"type":"boolean","description":"Enable Freeze key — allows freezing token transfers for specific accounts"},"enableKYC":{"type":"boolean","description":"Enable KYC key — allows granting/revoking KYC status for accounts"},"enableWipe":{"type":"boolean","description":"Enable Wipe key — allows wiping token balance from specific accounts"}},"required":["tokenId","tokenName","tokenSymbol","tokenType","initialSupply","decimals","changeSupply","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push":{"put":{"description":"Update token. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_updateTokenAsync","parameters":[],"requestBody":{"required":true,"description":"Object that contains token information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDTO"}}}},"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden.\n\nForbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Update token.","tags":["tokens"]}}}} ``` ## Deletes the token with the provided schema ID. > Deletes the token with the provided schema ID. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push/{tokenId}":{"delete":{"description":"Deletes the token with the provided schema ID. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_deleteTokenAsync","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Token cannot be deleted by current user or token is used in a published policy.\n\nForbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Token does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Deletes the token with the provided schema ID.","tags":["tokens"]}}}} ``` ## Delete multiple tokens. > Delete multiple tokens by their IDs. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push/delete-multiple":{"post":{"description":"Delete multiple tokens by their IDs. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_deleteTokensAsync","parameters":[],"requestBody":{"required":true,"description":"List of token IDs to delete.","content":{"application/json":{"schema":{"type":"object","required":["tokenIds"],"properties":{"tokenIds":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"One or more tokens cannot be deleted by current user or are used in published policies.\n\nForbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"No tokens found for provided IDs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Delete multiple tokens.","tags":["tokens"]}}}} ``` ## Associates the user with the provided Hedera token. > Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"tokenId":{"type":"string","description":"Hedera token ID"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"decimals":{"type":"string","description":"Number of decimal places"},"associated":{"type":"boolean","description":"Whether the current user is associated with this token"},"frozen":{"type":"boolean","description":"Whether the current user's account is frozen for this token"},"kyc":{"type":"boolean","description":"Whether the current user has passed KYC for this token"},"balance":{"type":"string","description":"Current token balance for the user"},"enableAdmin":{"type":"boolean","description":"Whether the token has an Admin key"},"enableFreeze":{"type":"boolean","description":"Whether the token has a Freeze key"},"enableKYC":{"type":"boolean","description":"Whether the token has a KYC key"},"enableWipe":{"type":"boolean","description":"Whether the token has a Wipe key"}},"required":["id","tokenId","tokenName","tokenSymbol","tokenType","decimals","associated","frozen","kyc","balance","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/associate":{"put":{"description":"Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.","operationId":"TokensApi_associateToken","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfoDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Associates the user with the provided Hedera token.","tags":["tokens"]}}}} ``` ## Associates the user with the provided Hedera token. > Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push/{tokenId}/associate":{"put":{"description":"Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.","operationId":"TokensApi_associateTokenAsync","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Associates the user with the provided Hedera token.","tags":["tokens"]}}}} ``` ## Associate the user with the provided Hedera token. > Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"tokenId":{"type":"string","description":"Hedera token ID"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"decimals":{"type":"string","description":"Number of decimal places"},"associated":{"type":"boolean","description":"Whether the current user is associated with this token"},"frozen":{"type":"boolean","description":"Whether the current user's account is frozen for this token"},"kyc":{"type":"boolean","description":"Whether the current user has passed KYC for this token"},"balance":{"type":"string","description":"Current token balance for the user"},"enableAdmin":{"type":"boolean","description":"Whether the token has an Admin key"},"enableFreeze":{"type":"boolean","description":"Whether the token has a Freeze key"},"enableKYC":{"type":"boolean","description":"Whether the token has a KYC key"},"enableWipe":{"type":"boolean","description":"Whether the token has a Wipe key"}},"required":["id","tokenId","tokenName","tokenSymbol","tokenType","decimals","associated","frozen","kyc","balance","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/dissociate":{"put":{"description":"Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.","operationId":"TokensApi_dissociateToken","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfoDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Associate the user with the provided Hedera token.","tags":["tokens"]}}}} ``` ## Associate the user with the provided Hedera token. > Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push/{tokenId}/dissociate":{"put":{"description":"Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.","operationId":"TokensApi_dissociateTokenAsync","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Associate the user with the provided Hedera token.","tags":["tokens"]}}}} ``` ## Transfers tokens from the authenticated user to the target account. > Transfers fungible or non-fungible tokens from the authenticated user's Hedera account to the specified target account. For FT, specify amount. For NFT, specify serialNumbers or amount (picks from end). ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TransferTokenDTO":{"type":"object","properties":{"targetAccount":{"type":"string","description":"Target Hedera account ID"},"amount":{"type":"number","description":"Amount (FT) or serial count to pick (NFT); must be > 0"},"serialNumbers":{"description":"Specific NFT serial numbers to transfer; positive integers","type":"array","items":{"type":"number"}},"memo":{"type":"string","description":"Optional transaction memo"}},"required":["targetAccount"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/transfer":{"post":{"description":"Transfers fungible or non-fungible tokens from the authenticated user's Hedera account to the specified target account. For FT, specify amount. For NFT, specify serialNumbers or amount (picks from end).","operationId":"TokensApi_transferToken","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferTokenDTO"}}}},"responses":{"200":{"description":"Successful operation."},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Transfers tokens from the authenticated user to the target account.","tags":["tokens"]}}}} ``` ## Transfers tokens from the authenticated user to the target account. > Transfers fungible or non-fungible tokens asynchronously. Returns a task ID for tracking. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TransferTokenDTO":{"type":"object","properties":{"targetAccount":{"type":"string","description":"Target Hedera account ID"},"amount":{"type":"number","description":"Amount (FT) or serial count to pick (NFT); must be > 0"},"serialNumbers":{"description":"Specific NFT serial numbers to transfer; positive integers","type":"array","items":{"type":"number"}},"memo":{"type":"string","description":"Optional transaction memo"}},"required":["targetAccount"]},"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push/{tokenId}/transfer":{"post":{"description":"Transfers fungible or non-fungible tokens asynchronously. Returns a task ID for tracking.","operationId":"TokensApi_transferTokenAsync","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferTokenDTO"}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Transfers tokens from the authenticated user to the target account.","tags":["tokens"]}}}} ``` ## Sets the KYC flag for the user. > Sets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"tokenId":{"type":"string","description":"Hedera token ID"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"decimals":{"type":"string","description":"Number of decimal places"},"associated":{"type":"boolean","description":"Whether the current user is associated with this token"},"frozen":{"type":"boolean","description":"Whether the current user's account is frozen for this token"},"kyc":{"type":"boolean","description":"Whether the current user has passed KYC for this token"},"balance":{"type":"string","description":"Current token balance for the user"},"enableAdmin":{"type":"boolean","description":"Whether the token has an Admin key"},"enableFreeze":{"type":"boolean","description":"Whether the token has a Freeze key"},"enableKYC":{"type":"boolean","description":"Whether the token has a KYC key"},"enableWipe":{"type":"boolean","description":"Whether the token has a Wipe key"}},"required":["id","tokenId","tokenName","tokenSymbol","tokenType","decimals","associated","frozen","kyc","balance","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/{username}/grant-kyc":{"put":{"description":"Sets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_grantKyc","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"username","required":true,"in":"path","description":"Username","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfoDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Sets the KYC flag for the user.","tags":["tokens"]}}}} ``` ## Sets the KYC flag for the user. > Sets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push/{tokenId}/{username}/grant-kyc":{"put":{"description":"Sets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_grantKycAsync","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"username","required":true,"in":"path","description":"Username","schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Sets the KYC flag for the user.","tags":["tokens"]}}}} ``` ## Unsets the KYC flag for the user. > Unsets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"tokenId":{"type":"string","description":"Hedera token ID"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"decimals":{"type":"string","description":"Number of decimal places"},"associated":{"type":"boolean","description":"Whether the current user is associated with this token"},"frozen":{"type":"boolean","description":"Whether the current user's account is frozen for this token"},"kyc":{"type":"boolean","description":"Whether the current user has passed KYC for this token"},"balance":{"type":"string","description":"Current token balance for the user"},"enableAdmin":{"type":"boolean","description":"Whether the token has an Admin key"},"enableFreeze":{"type":"boolean","description":"Whether the token has a Freeze key"},"enableKYC":{"type":"boolean","description":"Whether the token has a KYC key"},"enableWipe":{"type":"boolean","description":"Whether the token has a Wipe key"}},"required":["id","tokenId","tokenName","tokenSymbol","tokenType","decimals","associated","frozen","kyc","balance","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/{username}/revoke-kyc":{"put":{"description":"Unsets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_revokeKyc","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"username","required":true,"in":"path","description":"Username","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfoDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Unsets the KYC flag for the user.","tags":["tokens"]}}}} ``` ## Unsets the KYC flag for the user. > Unsets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push/{tokenId}/{username}/revoke-kyc":{"put":{"description":"Unsets the KYC flag for the user. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_revokeKycAsync","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"username","required":true,"in":"path","description":"Username","schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Unsets the KYC flag for the user.","tags":["tokens"]}}}} ``` ## Freeze transfers of the specified token for the user. > Freezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"tokenId":{"type":"string","description":"Hedera token ID"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"decimals":{"type":"string","description":"Number of decimal places"},"associated":{"type":"boolean","description":"Whether the current user is associated with this token"},"frozen":{"type":"boolean","description":"Whether the current user's account is frozen for this token"},"kyc":{"type":"boolean","description":"Whether the current user has passed KYC for this token"},"balance":{"type":"string","description":"Current token balance for the user"},"enableAdmin":{"type":"boolean","description":"Whether the token has an Admin key"},"enableFreeze":{"type":"boolean","description":"Whether the token has a Freeze key"},"enableKYC":{"type":"boolean","description":"Whether the token has a KYC key"},"enableWipe":{"type":"boolean","description":"Whether the token has a Wipe key"}},"required":["id","tokenId","tokenName","tokenSymbol","tokenType","decimals","associated","frozen","kyc","balance","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/{username}/freeze":{"put":{"description":"Freezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_freezeToken","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"username","required":true,"in":"path","description":"Username","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfoDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Freeze transfers of the specified token for the user.","tags":["tokens"]}}}} ``` ## Unfreezes transfers of the specified token for the user. > Unfreezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"tokenId":{"type":"string","description":"Hedera token ID"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"decimals":{"type":"string","description":"Number of decimal places"},"associated":{"type":"boolean","description":"Whether the current user is associated with this token"},"frozen":{"type":"boolean","description":"Whether the current user's account is frozen for this token"},"kyc":{"type":"boolean","description":"Whether the current user has passed KYC for this token"},"balance":{"type":"string","description":"Current token balance for the user"},"enableAdmin":{"type":"boolean","description":"Whether the token has an Admin key"},"enableFreeze":{"type":"boolean","description":"Whether the token has a Freeze key"},"enableKYC":{"type":"boolean","description":"Whether the token has a KYC key"},"enableWipe":{"type":"boolean","description":"Whether the token has a Wipe key"}},"required":["id","tokenId","tokenName","tokenSymbol","tokenType","decimals","associated","frozen","kyc","balance","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/{username}/unfreeze":{"put":{"description":"Unfreezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_unfreezeToken","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"username","required":true,"in":"path","description":"Username","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfoDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Unfreezes transfers of the specified token for the user.","tags":["tokens"]}}}} ``` ## Freeze transfers of the specified token for the user. > Freezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push/{tokenId}/{username}/freeze":{"put":{"description":"Freezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_freezeTokenAsync","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"username","required":true,"in":"path","description":"Username","schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Freeze transfers of the specified token for the user.","tags":["tokens"]}}}} ``` ## Unfreezes transfers of the specified token for the user. > Unfreezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push/{tokenId}/{username}/unfreeze":{"put":{"description":"Unfreezes transfers of the specified token for the user. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_unfreezeTokenAsync","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"username","required":true,"in":"path","description":"Username","schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Unfreezes transfers of the specified token for the user.","tags":["tokens"]}}}} ``` ## Returns user information for the selected token. > Returns user information for the selected token. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"tokenId":{"type":"string","description":"Hedera token ID"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"decimals":{"type":"string","description":"Number of decimal places"},"associated":{"type":"boolean","description":"Whether the current user is associated with this token"},"frozen":{"type":"boolean","description":"Whether the current user's account is frozen for this token"},"kyc":{"type":"boolean","description":"Whether the current user has passed KYC for this token"},"balance":{"type":"string","description":"Current token balance for the user"},"enableAdmin":{"type":"boolean","description":"Whether the token has an Admin key"},"enableFreeze":{"type":"boolean","description":"Whether the token has a Freeze key"},"enableKYC":{"type":"boolean","description":"Whether the token has a KYC key"},"enableWipe":{"type":"boolean","description":"Whether the token has a Wipe key"}},"required":["id","tokenId","tokenName","tokenSymbol","tokenType","decimals","associated","frozen","kyc","balance","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/{username}/info":{"get":{"description":"Returns user information for the selected token. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_getTokenInfo","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"username","required":true,"in":"path","description":"Username","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfoDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Returns user information for the selected token.","tags":["tokens"]}}}} ``` ## Return token serials. > Returns token serials of current user. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/serials":{"get":{"description":"Returns token serials of current user.","operationId":"TokensApi_getTokenSerials","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Token serials.","content":{"application/json":{"schema":{"type":"array","items":{"type":"number"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return token serials.","tags":["tokens"]}}}} ``` ## Return a list of tokens. > Returns tokens menu. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token ID (assigned after token creation on Hedera)"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"initialSupply":{"type":"string","description":"Initial supply of the token (set to 0 for mintable tokens)"},"decimals":{"type":"string","description":"Number of decimal places (0 for NFTs, typically 2 for fungible tokens)"},"changeSupply":{"type":"boolean","description":"Enable Supply key — allows minting and burning tokens"},"enableAdmin":{"type":"boolean","description":"Enable Admin key — allows managing token properties"},"enableFreeze":{"type":"boolean","description":"Enable Freeze key — allows freezing token transfers for specific accounts"},"enableKYC":{"type":"boolean","description":"Enable KYC key — allows granting/revoking KYC status for accounts"},"enableWipe":{"type":"boolean","description":"Enable Wipe key — allows wiping token balance from specific accounts"}},"required":["tokenId","tokenName","tokenSymbol","tokenType","initialSupply","decimals","changeSupply","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/menu/all":{"get":{"description":"Returns tokens menu. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_getMenu","parameters":[],"responses":{"200":{"description":"Modules.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TokenDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a list of tokens.","tags":["tokens"]}}}} ``` ## Returns user information for the selected token. > Returns user information for the selected token. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"tokenId":{"type":"string","description":"Hedera token ID"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"decimals":{"type":"string","description":"Number of decimal places"},"associated":{"type":"boolean","description":"Whether the current user is associated with this token"},"frozen":{"type":"boolean","description":"Whether the current user's account is frozen for this token"},"kyc":{"type":"boolean","description":"Whether the current user has passed KYC for this token"},"balance":{"type":"string","description":"Current token balance for the user"},"enableAdmin":{"type":"boolean","description":"Whether the token has an Admin key"},"enableFreeze":{"type":"boolean","description":"Whether the token has a Freeze key"},"enableKYC":{"type":"boolean","description":"Whether the token has a KYC key"},"enableWipe":{"type":"boolean","description":"Whether the token has a Wipe key"}},"required":["id","tokenId","tokenName","tokenSymbol","tokenType","decimals","associated","frozen","kyc","balance","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/relayer-accounts/{relayerAccountId}/info":{"get":{"description":"Returns user information for the selected token. Only users with the Standard Registry role are allowed to make the request.","operationId":"TokensApi_getRelayerAccountInfo","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"relayerAccountId","required":true,"in":"path","description":"Relayer Account Id","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfoDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Returns user information for the selected token.","tags":["tokens"]}}}} ``` ## Associates the user with the provided Hedera token. > Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"tokenId":{"type":"string","description":"Hedera token ID"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"decimals":{"type":"string","description":"Number of decimal places"},"associated":{"type":"boolean","description":"Whether the current user is associated with this token"},"frozen":{"type":"boolean","description":"Whether the current user's account is frozen for this token"},"kyc":{"type":"boolean","description":"Whether the current user has passed KYC for this token"},"balance":{"type":"string","description":"Current token balance for the user"},"enableAdmin":{"type":"boolean","description":"Whether the token has an Admin key"},"enableFreeze":{"type":"boolean","description":"Whether the token has a Freeze key"},"enableKYC":{"type":"boolean","description":"Whether the token has a KYC key"},"enableWipe":{"type":"boolean","description":"Whether the token has a Wipe key"}},"required":["id","tokenId","tokenName","tokenSymbol","tokenType","decimals","associated","frozen","kyc","balance","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/associate/{accountId}":{"put":{"description":"Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.","operationId":"TokensApi_associateWithAccountToken","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"accountId","required":true,"in":"path","description":"Account ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfoDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Associates the user with the provided Hedera token.","tags":["tokens"]}}}} ``` ## Associates the user with the provided Hedera token. > Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push/{tokenId}/associate/{accountId}":{"put":{"description":"Associates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.","operationId":"TokensApi_associateTokenWithAccountAsync","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"accountId","required":true,"in":"path","description":"Account ID","schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Associates the user with the provided Hedera token.","tags":["tokens"]}}}} ``` ## Associate the user with the provided Hedera token. > Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TokenInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"tokenId":{"type":"string","description":"Hedera token ID"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"decimals":{"type":"string","description":"Number of decimal places"},"associated":{"type":"boolean","description":"Whether the current user is associated with this token"},"frozen":{"type":"boolean","description":"Whether the current user's account is frozen for this token"},"kyc":{"type":"boolean","description":"Whether the current user has passed KYC for this token"},"balance":{"type":"string","description":"Current token balance for the user"},"enableAdmin":{"type":"boolean","description":"Whether the token has an Admin key"},"enableFreeze":{"type":"boolean","description":"Whether the token has a Freeze key"},"enableKYC":{"type":"boolean","description":"Whether the token has a KYC key"},"enableWipe":{"type":"boolean","description":"Whether the token has a Wipe key"}},"required":["id","tokenId","tokenName","tokenSymbol","tokenType","decimals","associated","frozen","kyc","balance","enableAdmin","enableFreeze","enableKYC","enableWipe"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/{tokenId}/dissociate/{accountId}":{"put":{"description":"Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.","operationId":"TokensApi_dissociateWithAccountToken","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"accountId","required":true,"in":"path","description":"Account ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfoDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Associate the user with the provided Hedera token.","tags":["tokens"]}}}} ``` ## Associate the user with the provided Hedera token. > Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/tokens/push/{tokenId}/dissociate/{accountId}":{"put":{"description":"Disassociates the user with the provided Hedera token. Only users with the Installer role are allowed to make the request.","operationId":"TokensApi_dissociateTokenWithAccountAsync","parameters":[{"name":"tokenId","required":true,"in":"path","description":"Token ID","schema":{"type":"string"}},{"name":"accountId","required":true,"in":"path","description":"Account ID","schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Associate the user with the provided Hedera token.","tags":["tokens"]}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://dev.guardian.hedera.com/api-reference/tokens.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.