Issue a user identification key

Issuing a user identification key is a feature that helps you reliably identify users inside a mini app without any separate server integration or user consent process.

The moment a user enters the mini app, a mini app semi-member profile for that user is created. Based on this user, the mini app can manage information such as service usage data, stored data, rankings, and points.

Toss Login migration

If you have been identifying users with Toss Login, you can switch to the user identification key issuance method. It is suitable when user identification is needed without a separate login screen or server integration.

What is a user identification key?

A user identification key is a unique key value used to distinguish one user within a mini app. It helps the mini app reliably recognize the same user internally without directly exposing the user's personal information.

The returned user identifier is unique to each mini app. Even for the same Toss user, different identification keys are used in different mini apps.

Please make sure to check

• Within the same mini app, the same identification key is always returned for the same user.

• Even if the app is deleted or the device changes, the same identification key is returned as long as it is the same user.

• You must use the issuance method that matches the mini app type. Using it in another type may cause errors.

• In the sandbox, mock data is returned. Please test the actual behavior in the Toss app using a QR code.

How it is used by mini app type

The method for issuing a user identification key differs depending on the mini app type.

Mini app type	Purpose	Description
Game	Game user identification	Used when managing game data, rankings, points, save data, and more on a per-user basis.
Non-game	General mini app user identification	Used when managing service usage history, user-specific settings, stored data, and more on a per-user basis.

Game mini app

In a game mini app, you receive a user identification key as a dedicated method for identifying users inside the game. Without showing a separate authentication screen like Toss Login, you can use a unique user identifier inside the game mini app.

This identification key is valid only within the corresponding game mini app. It can be used for data that needs to be connected based on the user, such as in-game data storage, ranking management, point management, and save data management.

Caution

• It can only be used in game mini apps.

• In Toss app versions lower than the supported version, a user identification key may not be provided.

• To provide identifiers for all users more reliably, the minimum supported Toss app version for game mini apps has been raised.

• Below the supported version, an update guidance screen is shown when entering the mini app.

• In the sandbox environment, mock data is returned. Please test the actual behavior in the Toss app using a QR code.

Non-game mini app

In non-game mini apps, you receive a user identification key as a method for identifying users within a general service. Without a separate authentication screen or server integration, you can use a unique user identifier inside the mini app.

This identification key is valid only within the corresponding mini app. It can be used for data that must be managed based on the user, such as user-specific settings, usage history, and stored data.

Caution

• It can only be used in non-game mini apps.

• In environments below the supported version, a user identification key may not be provided.

• The returned user identification key is not a key for calling the Toss server API.

• Please use it only for internal user identification and data management.

• In the sandbox environment, mock data is returned. Please test the actual behavior in the Toss app using a QR code.

Examples of using the user identification key

The user identification key can be used when you need to continue managing data based on the user inside the mini app.

• Managing a user's service usage history

• Saving user-specific settings

• Managing game rankings, points, and save data

• Restoring a returning user's previous state

• Building personalized experiences provided without login

A user identification key is a value used to distinguish users. It is not a feature that replaces personal information such as a user's real name, phone number, or account information.

Develop

How to receive a user identification key in a non-game mini app is User.getAnonymousKeyPlease check here.