User properties

Read

Use me() to retrieve the user's properties on Android, iOS, and web after Kakao Login. The properties dictionary keeps Kakao's original keys, including custom keys registered for the app. It is empty when the response contains no properties.

import { me } from '@react-native-kakao/user';

const user = await me();
const nickname = user.properties.nickname;

const { properties } = await me({ propertyKeys: ['properties.'] });
const selected = await me({ propertyKeys: ['properties.nickname'] });

propertyKeys forwards Kakao's property_keys filter without changing its keys. Omit it to request the default user information. Use properties. to request all available properties, or a specific key such as properties.nickname to select one. Other supported keys, such as kakao_account.email, select Kakao Account fields. Fields excluded by the filter are not available in the response.

The property keys and returned values depend on the app's user-property settings, the user's consent, and which data Kakao returns. The dictionary has type Record<string, string>; do not assume a particular key is present. Calling this API reads user information without updating the profile or requesting additional consent.

See Kakao's user-information guide for supported filters and properties.

Store

Use updateProfile({ properties }) to save registered custom property keys with string values. It resolves with no result on success and rejects SDK errors on Android, iOS, and web.

Register keys in Kakao Developers under Kakao Login > Advanced > User Properties before calling it. The user must be logged in.

import { updateProfile } from '@react-native-kakao/user';

await updateProfile({ properties: { custom_key: 'value' } });

This stores app-specific user properties. It does not edit the user's Kakao Account profile, nickname, or profile image.

See Kakao's user-property API for prerequisites and errors.