Token Actions

The Kigo API provides several actions that users can perform on tokens within their wallet, including claiming, revealing, redeeming, sharing, and hiding tokens. These actions are central to how users interact with their digital assets in the Kigo ecosystem.

Prerequisites

Before performing any action on a token, ensure that the necessary user-level session token has been obtained. This token is required to authenticate API requests and can be acquired by following the User Client Level Authentication.

Overview of Token Actions

1. Claim Token

   • Purpose: Transfer ownership of a token to the user's account.
   • Details: Claiming is often the first step in utilizing a token. More details can be found in the Claim Tokens Guide

2. Reveal Token

   • Purpose: Uncover hidden content within a token, such as a bundle of tokens or the details of a hidden gift card.
   • Details: Specific flags within the token data indicate if it can be revealed. For more, see the Reveal Tokens Guide

3. Redeem Token

   • Purpose: Utilize the value associated with a token, such as applying a discount or using a gift card.
   • Details: Different types of redeem actions are available depending on the token's nature. Further information is provided in the Redeem Tokens Guide

4. Share Token

   • Purpose: Allow a token to be transferred or shared with another user.
   • Details: Not all tokens are shareable; flags in the token data indicate if this action is possible. For details, see the Share Tokens Guide

5. Hide Token

   • Purpose: Temporarily remove a token from the visible list in the user’s wallet.
   • Details: All tokens can be hidden. Check the Hide Token Guide for more.

Key Considerations

• Action Availability: The availability of each action is determined by fields in the token's metadata, such as supported_actions and flags.
• Token Management: Understanding the available actions and how to determine their availability is crucial for effectively managing tokens in the Kigo ecosystem.