Skip to main content

Get My KakaoTalk Profile

Retrieve My KakaoTalk Profile​

Official Documentation

info

To receive a complete API response, Kakao login must be activated and consent items related to profile information, nickname, and profile picture must be agreed upon.

Usage​

You can retrieve your KakaoTalk profile using getTalkProfile().

It is defined as follows:

export function getTalkProfile(): Promise<KakaoTalkProfile>

It has the following type:

export interface KakaoTalkProfile {
  /**
   * KakaoTalk nickname
   *
   * Required consent items: Profile information (nickname/profile picture) or nickname
   */
  nickname?: string;
  /**
   * Country where the user is using KakaoTalk
   *
   * @deprecated
   * @link https://devtalk.kakao.com/t/api-change-notice-response-fields-of-the-retrieving-kakao-talk-kakao-story-api/115151
   */
  countryISO?: string;
  /**
   * KakaoTalk profile image URL
   * Size: 640px * 640px, HTTPS only
   *
   * Required consent items: Profile information (nickname/profile picture) or profile picture
   */
  profileImageUrl?: string;
  /**
   * KakaoTalk profile thumbnail image URL
   * Size: 110px * 110px, HTTPS only
   *
   * Required consent items: Profile information (nickname/profile picture) or profile picture
   */
  thumbnailUrl?: string;
}

For the latest description of the response values, refer to the Official Documentation.