Skip to main content
Glama

identity_verify_kyc

Verify KYC status of Hedera accounts for token compliance. Check grant status and verification history using Hedera Toolbox's blockchain data access.

Instructions

Check the KYC status of a Hedera account for one or more tokens. Returns KYC grant status and verification history. Costs 0.2 HBAR.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
api_keyYesYour HederaIntel API key
account_idYesHedera account ID to check KYC for
token_idNoOptional token ID to check KYC status for a specific token

Implementation Reference

  • The identity_verify_kyc tool handler, which fetches an account's token list from the Hedera Mirror Node and analyzes KYC and freeze statuses.
    if (name === "identity_verify_kyc") {
      const payment = chargeForTool("identity_verify_kyc", args.api_key);
      const base = getMirrorNodeBase();
    
      const resolved = await resolveAccountInput(args.account_id, base);
      const hederaId = resolved.hederaId;
    
      // Fetch account token relationships
      const tokenRes = await axios.get(
        `${base}/api/v1/accounts/${hederaId}/tokens?limit=100&order=desc`
      ).catch(() => ({ data: { tokens: [] } }));
      const tokens = tokenRes.data.tokens || [];
    
      // Filter by token_id if provided
      const filtered = args.token_id
        ? tokens.filter(t => t.token_id === args.token_id)
        : tokens;
    
      const kycResults = filtered.map(t => ({
        token_id: t.token_id,
        kyc_status: t.kyc_status || "NOT_APPLICABLE",
        kyc_granted: t.kyc_status === "GRANTED",
        freeze_status: t.freeze_status || "NOT_APPLICABLE",
        balance: t.balance,
      }));
    
      const grantedCount = kycResults.filter(r => r.kyc_granted).length;
      const revokedCount = kycResults.filter(r => r.kyc_status === "REVOKED").length;
      const notApplicableCount = kycResults.filter(r => r.kyc_status === "NOT_APPLICABLE").length;
    
      // Fetch account info for context
      const accountRes = await axios.get(`${base}/api/v1/accounts/${hederaId}`)
        .catch(() => ({ data: {} }));
      const account = accountRes.data;
    
      return {
        account_id: hederaId,
        input: args.account_id,
        input_type: resolved.inputType,
        token_filter: args.token_id || null,
        total_token_relationships: tokens.length,
        kyc_summary: {
          granted: grantedCount,
          revoked: revokedCount,
          not_applicable: notApplicableCount,
          total_checked: kycResults.length,
        },
        kyc_details: kycResults,
        account_memo: account.memo || null,
        note: notApplicableCount === kycResults.length
          ? "All tokens show NOT_APPLICABLE - these tokens do not use Hedera KYC keys."
          : grantedCount > 0
          ? "Account has KYC granted for " + grantedCount + " token(s)."
          : "No KYC grants found for this account.",
        payment,
        timestamp: new Date().toISOString(),
      };
    }
  • Input schema definition for the identity_verify_kyc tool, specifying required account_id, optional token_id, and API key.
      name: "identity_verify_kyc",
      description: "Check the KYC status of a Hedera account for one or more tokens. Returns KYC grant status and verification history. Accepts both Hedera native IDs (0.0.123456) and EVM addresses (0x...). Costs 0.5 HBAR.",
      inputSchema: {
        type: "object",
        properties: {
          account_id: { type: "string", description: "Hedera account ID (e.g. 0.0.123456) or EVM address (0x...)" },
          token_id: { type: "string", description: "Optional token ID to check KYC status for a specific token" },
          api_key: { type: "string", description: "Your HederaIntel API key" },
        },
        required: ["account_id", "api_key"],
      },
    },
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries full burden. It discloses key behavioral traits: it's a read operation ('Check', 'Returns'), includes cost ('Costs 0.2 HBAR'), and output content ('KYC grant status and verification history'). It doesn't cover error cases, rate limits, or authentication details beyond the api_key parameter.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences with zero waste: purpose, output, cost. Front-loaded with core functionality. Each sentence earns its place by adding distinct value (operation, returns, cost).

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read tool with no annotations and no output schema, the description covers purpose, output content, and cost adequately. However, it lacks context on error handling, typical response structure, or how to interpret KYC status results, leaving gaps for agent invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents parameters. The description adds no parameter-specific semantics beyond implying token_id is optional for multi-token checks. Baseline 3 is appropriate as the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Check'), target resource ('KYC status of a Hedera account'), and scope ('for one or more tokens'). It distinguishes from siblings like identity_check_sanctions (different check type) and identity_resolve (different identity operation).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing KYC-enabled tokens), exclusions, or compare with siblings like identity_check_sanctions (sanctions vs KYC). The cost mention hints at usage but not decision criteria.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mountainmystic/hederatoolbox'

If you have feedback or need assistance with the MCP directory API, please join our Discord server