This document explains what you have to do before integrating Kakao Login.

To use Kakao Login, you must set Usage settings and Redirect URI. Set OpenID Connect when necessary.

To use Kakao Login, set [State] in [Kakao Login] > [Enable] on the app management page to [ON]. If [Status] is set to [OFF], a KOE004 error occurs when requesting Kakao Login.

To use Kakao Login, a redirect URI must be registered. Kakao Login delivers the authorization code and token requested by the service to the redirect URI. If the redirect URI is incorrect, a KOE006 error occurs during Kakao Login. Refer to the configuration location and method by call type below.

• REST API: In [App] > [Platform key] > [REST API key] on the app management page > [Redirect URI]
• Kakao SDK for JavaScript: In [App] > [Platform key] > [JavaScript key] on the app management page > [Redirect URI]

A Client secret is a security feature that requires including a specific code issued by Kakao Developers in a request to obtain a Kakao Login token.

For service security, the REST API key (including the key automatically created with the app) is added with the Client secret feature enabled, and the related parameter must be included when issuing a token. Refer to the Client secret configuration location and method below.

• In [App] > [Platform key] > [REST API key] on the app management page > [Client secret]

When OpenID Connect is enabled, both an access token and an ID token are issued when logging in with Kakao Login. Follow the steps below to enable OpenID Connect in [Kakao Login] > [OpenID Connect] on the app management page.

1. Set [State] to [ON] in [Usage settings] to activate Kakao Login. You can use OpenID Connect only when Kakao Login is enabled.
2. Set [State] to [ON] in [OpenID Connect] to activate OpenID Connect.

A consent item is a setting that allows the service to obtain user permission to access specific information or use features. For the details and a full list, see Consent items.

You can enable consent items in [Kakao Login] > [Consent Items] on the app management page. For the details on configuration, see the descriptions by item below.

You can set consent items required for retrieving service information or using features. See the step-by-step guide below.

The following are the configurable lists of [A] Personal information consent items and [B] Access permission consent items. Refer to the full lists of each consent item below to check which items require user consent in your service.

• Personal information consent items
• Access permission consent items

Select [Set] for the desired consent item in either [Personal information] or [Access permission]. For some consent items, you must first complete Request additional features before configuring them.

Select [A] consent types and enter the usage purpose in [B] [Consent purpose], then select [Save].

When you select the checkbox for [C] [Provision after collecting information through Kakao Account], information that is not registered in Kakao Account is also collected and provided after obtaining the user's consent. For details on this feature, see Provision after collecting information through Kakao Account.

You can check the components of the consent screen that users will see during actual Kakao Login by selecting [Preview Consent Screen] under [Kakao Login] > [Consent items] on the app management page.

Some consent items require additional feature permissions to be enabled. The required permissions for each item to set consent items can be found in Personal information consent items and Access permission consent items.

For how to request consent item permissions, see Request additional features.

The primary channel is the Kakao Talk Channel displayed on the consent screen during Kakao Login.

1. Connect Kakao Talk Channel to your app.
2. On the app management page, select [Select primary channel] in [Kakao Login] > [Consent items] > [Primary channel] to choose one of the connected Kakao Talk Channels as the primary channel.

You can register Transfer of personal information overseas information in [Kakao Login] > [Consent Items] > [Transfer of personal information overseas] on the app management page.

[A] Country where personal information is stored: Enter the name of the country where personal information will be transferred.
[B] Corporation name: Enter the name of the corporation that will receive the personal information.
[C] Contact: Enter the contact information of [B] for personal information inquiries, such as the email address, phone number, or customer service URL of the person responsible for information management.

Based on the information entered, the [Consent to transfer personal information overseas] required consent item is added to the Kakao Login consent screen. Users can select [view more] for this item to check the details and agree.

The Simple Signup feature, you can display service terms configured in your app on the Kakao Login consent screen to easily obtain user consent for the terms.

To use Simple Signup, follow as below.

1. Check eligibility for additional features
2. Request business information review.
3. Connect Kakao Talk Channel to app.
4. Register a service term and enable it in [Kakao Login] > [Simple Signup] on the app management page.
5. Set [Usage settings] to [ON]. At least one terms must be enabled to enable the Simple Signup.

You can register a new service terms by selecting [Add a service term] in [Kakao Login] > [Simple Signup] on the app management page. You must comply with Service terms management.

[A] Add a service term: Registers information of a service term.
[B] Add age consent for age 14 and over
[C] List of enabled terms: Displays the terms that are set to use (ON) among registered terms.
[D] Inactivated service terms: Displays the terms that are not used (OFF) among registered terms.
[E] Preview Consent Screen: Displays preview of Kakao Login consent screen reflecting the set terms.
[F] Change order: Changes the display order of service terms on the Kakao Login consent screen.
[G] Edit: Changes the settings for each term.
[H] Usage setting: Select whether to display on Kakao Login consent screen.

When adding service terms, you must set the following information.

[A] Title: Enter both Korean and English titles.
[B] URL: Enter the web page URL where the terms content can be checked.
[C] Consent level: Select the consent level to request consent from users (required or optional consent item).
[D] Tag: Enter a unique value to distinguish each service terms.

Refer to the below for the available formats for each item.

• Title
  • Korean service terms titles support only Korean, English, numbers, spaces, and special characters that can be entered directly from the keyboard (up to 45 characters).
  • English service terms titles support only English, numbers, spaces, and special characters that can be entered directly from the keyboard (up to 100 characters).
  • Even if there is no English service terms, enter the English service terms title in English. The English terms title is used when the user's device language is set to English.
• URL
  • For optional service terms only, the URL can be omitted.
• Consent level
  • Service terms that must be agreed to at the time of sign-up must be set as [required consent] consent item.
  • According to the scope of service provision, terms that can be additionally agreed to by users should be set as [optional consent] consent item.
• Tag
  • Use the tag when making Kakao API requests below. Enter a value that can be used in actual service development.
    • Retrieve consent details for service terms: Check details of the service terms agreed by the user.
    • Get consent to desired service terms: Request a specific service terms consent from the user.
    • Revoke consent for service terms: Request revocation of the user's consent for the service terms.
  • Only English, numbers, hyphens (-), and underscores (_) can be entered.
  • The following formats are recommended: ${KEYWORD}_${DATE}, ${KEYWORD}_${ORDER} (Example: terms_20220701, terms_01).

You can use the Logout of service and Kakao Account feature by registering the logout redirect URI in [Kakao Login] > [Advanced] > [Logout redirect URI] on the app management page.

The logout redirect URI supports HTTP/HTTPS protocols and ports 80 and 443, and distinguishes between HTTP and HTTPS protocols, so each must be registered separately. Up to 10 logout redirect URIs can be registered. If you need to register more than 10, contact DevTalk.

You can register user property keys and check the stored values for members linked to the app in [Kakao Login] > [Advanced] > [User property] on the app management page. Up to 5 user property keys (excluding user property reserved keys) can be registered per service.

[A] Add property key
[B] Delete property key
[C] Account information: Account information of members linked to the app.
[D] Reserved property: User property reserved keys and stored values.
[E] User property: Added user property keys and stored values.

nickname, profile_image, and thumbnail_image are reserved keys used by the Kakao platform and cannot be used for user property key registration.