Application

This document provides information about an application (hereinafter referred to as "app").

App management

Each service should have exactly one app. If you are already using Kakao Login or KakaoTalk Sharing, and thus have an existing app registered, continue using that existing app. Do not register a new one. If you lose access to the administrator account and cannot use the existing app, request an app owner change on DevTalk.

App ID

When you create an app, the app is assigned a unique ID to identify it. You can check the app ID in [My Application] or in the app information section of the console or tools.

When you make inquiries on DevTalk, share your app ID. Then, you can receive faster responses.

Basic information

Register the basic information of the service that will use the Kakao APIs in your app.

After creating an app, you can edit the details in [My Application] > [General] > [Basic information].

🅐 App icon: Service logo or app icon. File size must be under 250 KB; a size of 128×128 or less is recommended. 🅑 App name (required): Service name. 🅒 Company name (required): Business, corporation, or organization name operating your service. 🅓 Category (required): The category that best fits your service.

Basic information is displayed in various places, such as the Kakao Login consent screen, Connected Services management, or the footer of KakaoTalk messages. It is also required for business verification. To ensure user confidence in your service, you must enter the basic information exactly as it appears in your actual service.

App key

The app keys are needed for the authorization of Kakao API requests. To check the app keys, go to [My Application] > [App Keys].

The app keys are issued by the platform. If an app key is used on the wrong platform, an error response is returned.

• Native app key: Used to initialize the Kakao SDK for Android or initialize the Kakao SDK for iOS.
• REST API key: Used to call APIs using a REST API.
  Pass this key in the HTTP request header when you send a request in a server environment.
• JavaScript key: Used to initialize the Kakao SDK for JavaScript SDK.
• Admin key: Used to call the APIs intended for administrators using a REST API. Be sure that your app’s Admin key does not get exposed because this key has all permissions.

Reissue

If one of the app keys is revealed, the OWNER can reissue the app keys. Make sure that the reissue is irreversible. After the reissue, the app keys in the service app or website must be changed to the reissued value.

Platform

Kakao APIs are only allowed to the services that registered platform information. To register platform information, go to [My Application] > [Platform].

Note: Error due to incorrect platform information

If the registered platform information is different from the actual service, invalid android_key_hash or ios_bundle_id or web_site_url error occurs. In this case, check the list below.

• Android: Check if the registered [Package name] is the same as the value of the package attribute in AndroidManifest.xml and if a Key hash is registered.
• iOS: Check if the registered [Bundle ID] is the same as the value of the [Project] > [TARGETS] > [General] > [Identity] > [Bundle Identifier].
• Web: Check if the site domain used to call the Kakao API is registered.

Note: Market URL

A market URL is an open market URL registered in [Platform]. Messages sent by Kakao Talk Sharing or Kakao Talk Messaging APIs provide a link to launch the service app. If the service app is not installed on the user's device when launching the service app, the market URL will be opened.

Android

🅐 Package Name

• Unique identifier of the Android app
• Enter the value of the package attribute in AndroidManifest.xml

🅑 Market URL

• If [Google Play] is selected, market URL is automatically entered with [Package Name]
• If [Enter directly] is selected, enter the full market URL, such as One store

🅒 Key hash

• Key hashes to authenticate for Kakao API requests
• Refer to Add key hashes and register key hashes by the development environment

iOS

🅐 Bundle ID

• Unique identifier of the iOS app
• Enter the value of [Bundle Identifier] in the Xcode project information

🅑 Appstore ID and Market URL

• Enter the App ID in the Appstore
• Market URL is automatically entered with [App ID]

Web

🅐 Site domain

• Required to use Kakao SDK for JavaScript, Kakao Talk Sharing, Messaging API
• Enter the site domain in http, https, file format
• If the service website is served with both http and https, enter either one of them
• Up to 10 site domains are allowed by default
  • To register more than 10 site domains, set wildcard subdomains or request permission (Note: Restrictions on the number of site domain and how to add additional site domains)

🅑 Default domain

• If more than one site domain is registered, the site domain registered on the top line is set to the default domain
• Default domain is used as the default value for the link in the message that sent by Kakao Talk Sharing or Kakao Talk Messaging APIs

Note: Wildcard subdomains

Biz app is allowed to set wildcard subdomains Kakao Login Redirect URIs. When using subdomains containing wildcard characters, refer to the rules below.

• Domains with wildcard characters cannot be the default domain
• If only domains with wildcard characters are registered, some functions may not work properly
• Each subdomain must include a unique domain name or hostname
  • https://*.sample.com (O)
  • https://*.com (X)
• Subdomains cannot include wildcard characters in the middle of the domain
  • https://*.sample.com (O)
  • https://sub.*.sample.com (X)
• Subdomains cannot include more than two wildcard characters
  • https://*.sample.com (O)
  • https://*.*.sample.com (X)

Team management

A team is a system to manage access permission by developer account for each app. Only the developers with developer accounts are registered as team members can view or modify the app information. Only the team members are authorized to make Kakao API calls for a test app. To manage a team, go to [My Application] > [Team Management].

Role type

• OWNER
  • The user who owns the app
  • Available to view or modify all of the app settings, invite a member, switch to a Biz app, reissue app keys, delete the app, or Request for app permissions
• EDITOR
  • Available to view or modify app settings, or Request for app permissions
  • Not available to invite a team member, reissue app keys, or delete the app
• EDITOR_MESSAGE_TEMPLATE
  • Available to view app settings and create or modify message templates
• READER
  • Available to view app settings only

How to manage

🅐 Invite team member

• Enter the email of the developer account and set a role
• Only the email used for logging in with a Kakao Account is allowed
• An email will be sent when inviting
• If required, a new Kakao Account can be registered on the Kakao Account page

🅑 Team member information and management

• Kakao Account: The email of the team member's Kakao Account
• Role: The team member's role type
• State: The team member's state
  • Active: A user who registered as a developer account and a team member properly
  • Invitation sent: A user who has registered as a developer account not yet, can be a team member through the invitation email
  • Dormant: A user who is in the dormant state, the user's email is not shown to all team members and cannot be modified or exported
• Management
  • Provides role modification and export function
  • OWNER can [Edit] or [Export] for each team member
  • Team members can export themselves from the team using [Leave the team]
  • OWNER role can be transferred to other team members by modifying team member permissions

How to change OWNER

1. Login to the Kakao Developers with the OWNER developer account
2. Add the new developer account as a team member on [My Application] > [Team Management] > [Invite team member]
   • To use a new Kakao Account, sign up a new Kakao Account and register as a developer account in Kakao Developers
3. Click [Modify] on the team member list and change the role to the OWNER

If the app OWNER is unknown or missing, refer to FAQ.

Biz app

The Biz app is an application that has registered the service's business registration number.

Additional features

The Biz app provides additional features below.

• Available to connect to a business channel of the same business registration number in [My Application] > [Request for App Permission]
• Available to set the consent item [Email] as a required consent
• Available to set subdomains
• Available to use Kakao Sync
• Available to use Retrieve a list of Kakao Talk friends API
• Available to use Messaging APIs
• Available to Request for app permissions

Switch to a Biz app

To upgrade the app to a Biz app, in the [My Application] > [Business] > [Biz App Information], and enter the business registration number by selecting [Register business information]. Only the OWNER can switch the app to a Biz app.

Note: Biz app for an individual

The Biz app is also available for individuals, celebrities, or governmental entities without a business registration number. If the app meets the guidelines below, it can be switched to a Biz app on [My Application] > [Business] > [Biz app for an individual].

• The app's OWNER must complete the user identification process on [Account settings] at the top right side of Kakao Developers
• Consent to Kakao Business consolidated service terms.

Note: Link with a Business channel

The Biz app for an individual cannot link with a Business channel because it has no business information. If Kakao Sync is needed, the app must have the business information to link with a Business channel. The business information can be registered on [My Application] > [Business] even after switching to a Biz app for individuals.

For overseas companies

If an overseas corporation operates the service, request a review through Devtalk to switch to a biz app. Leave the information below.

• The app ID and app name
• Required APIs or functions

During the review, we will ask for the certificate that authenticates the overseas corporation.

Test app

The test app is provided for updating or adding a new feature to the service. The test app has built-in permissions to preview features before requesting a review. Belows are the main features that the test app provides

• Built-in permissions for test apps to preview features before submitting a review of the original app
• Available to use independent test app settings that differ from the original app settings
• Permissions are automatically applied to the test app when permissions are added or deleted to the original app (Ex: Kakao Business privacy review or separate permissions for APIs, such as Kakao Social, Messages, and Talk Calendar)

Limitations

Consider the limitations below when using test apps.

• Creation and deletion
  • Only the Biz app can create the test app.
  • Up to 5 apps can be created per original app.
  • Deletion of an original app is not possible if it has test apps.
• Team management
  • At the time of initial creation, the OWNER and team members of the test app are the same as those of the original app.
    • When the OWNER of the original app is changed, the test app OWNER is also changed, and the test app OWNER cannot be changed separately.
    • Team members of the test app, excluding the OWNER, can be added or removed independently of the original app.
  • A separate maximum team member limit is applied.
• Feature usage
  • Only team members of the test app can use the test app.
  • For the below products, APIs that require permissions can only be called by the team members of the test app, even if the original app has acquired the permissions. The response range is also limited to those team members.
    • KakaoTalk Message, KakaoTalk Social, Talk Calendar.
  • A separate quota limit is applied.

Built-in permissions for test apps

Below is the complete list of permissions provided for the default test app. To use additional permissions in the original app, you need to obtain the permissions separately by reviewing.

• Basic features and permissions of the app
• Additional features and permissions for the Biz app
• Available consent type in the Personal information (provide additional required or optional consent permissions)
  • Email (account_email): Required
  • Name (name): Optional, Required
  • Gender (gender): Required
  • Age range (age_range): Required
  • Birthday (birthday): Required
  • Birthyear (birthyear): Optional, Required
  • Phone number (phone_number): Optional, Required
  • Shipping information (recipient name, shipping address, phone number) (shipping_address): Optional, Required
• Kakao Login: Set Simple Signup
• Kakao Login: Retrieve shipping address

How to create

To create a test app, go to [My Application] > [General] > [Test App Information], and select [Create a test app]. Select the name of the test app to go to the settings screen.

The test app provides a separate app key, independent settings, and permissions that differ from the original app.

Request for app permissions

Requests your app be reviewed for additional permissions. After review, you will be provided with approved permissions to utilize. For the List of permissions you can currently request with Request for app app permissions, see Request for app permissions list.

To request app permission review, go to [My Application] > [Request for App Permissions]. You must complete Confirm qualifications before the request. Refer to the details below.

For information on viewing and disconnecting Kakao Talk Channel lists, refer to Manage Kakao Talk Channel Connection.

🅐 Confirm qualifications 🅑 Verify business information 🅒 List of app permissions 🅓 Review state

Confirm qualifications

Checks the app and account's qualifications to request for app permissions. The app and account must meet the Conditions for confirming qualifications.

1. If you do not meet the Conditions for confirming qualifications, guidance related to 🅐 Confirm qualifications will be displayed. Follow the instructions to configure your app or account.
2. If you meet the Conditions for confirming qualifications, a [Confirm Qualifications] button will appear under 🅐 Confirm qualifications. Click this button to open a window for Confirm qualifications.
3. After reviewing and agreeing to the details, the qualification confirmation will be completed.

Conditions for confirming qualifications

• OWNER or EDITOR role: The access account requires app OWNER or EDITOR role.
• Identity verification: If the identity verification is not incompleted, follow the instructions to verify your identity.
• Biz app: If the app is not a Biz app, swiching to a Biz app is required. (See Biz-app)

Verify business information

Requests for business information verification for the app.

1. Business verification is available after Confirm qualifications. Until then, the [Request] is disabled.
2. When selecting [Request] for 🅑 Verify business information, the [Business information] input window opens.
3. Fill in the inputs by referring to the instructions and cautions for each item, and request.

List of app permissions

Requests a review for your app to get additional permissions. You can find the permissions you can request in the Request for app permissions list.

1. Permission review is available after Confirm qualifications is complete. Until then, the [Request] in the permission list is disabled.
2. Select [Request] in the 🅒 List of app permissions to open the review request window for that permission. If you request for a permission that requires Verify business information and it is not completed, the business verification window will open first. You can continue after completing business verification.
3. Refer to the guidance and precautions for each item, fill in the inputs, and submit.
4. The Review state can be checked in the [State] column, where the [Request] button was located. The approval or rejection state of the requested review will also be sent to the email registered to the account.

Review state

Displays the state of the permission review as below.

• In progress: The review has been requested and is currently being reviewed by a staff member.
• Approved: The request has been approved and the app has been granted permission.
• Partially approved: The request has been partially approved and the app has been granted part of the permission.
• Rejected: The request was not approved and the app was not granted permission, need to resubmit with deficiencies.

Manage Kakao Talk Channel connection

🅐 List of Kakao Talk Channels

You can check the list of Kakao Talk Channels connected to your app and disconnect them if necessary.

1. Select [Disconnect] of the channel you want to disconnect from the 🅐 List of Kakao Talk Channels to open the [Disconnect Kakao Talk Channel] window.
2. Before disconnecting, read the Precautions for disconnecting. Once you have fully understood and agree with the content, select [Disconnect] to disconnect the channel.
3. You can reconnect a disconnected Kakao Talk Channel by selecting [Connect] from [Request for App Permissions] > [Connect Kakao Talk Channel].

Billing

Enables additional paid calls after exhausting the Free quotas for the Paid API. See below for the details.

Billing usage process

The entire process of using APIs and paying the billed amount after enabling paid settings. See related documents of each step for the details.

1. Go to [My Application] > [Billing] > [Biz Wallet] and connect a Biz Wallet.
2. Enable Paid usage setting for the required APIs listed under in [My Application] > [Billing] > [Paid API].
3. Check the monthly usage and estimated charges for each API in [My Application] > [Billing] > [Invoice].
4. Monthly charges will be automatically paid via the Biz Wallet around 1 AM on the 1st of each month.

Biz Wallet information

This is the Biz Wallet information connected to the app. For details on create, connect, change, or disconnect a Biz Wallet, refer to Biz Wallet.

Paid API

This is a list of APIs that can be configured with paid settings. Only items for which the app has the appropriate Permission are displayed. Detailed API lists for tracking actual usage and billing can be found under Additional quota usage fees.

API	Description	Related documents
KakaoMap	Provides Kakao Map content and data for use in web and app services.	Map Local

Paid usage setting

In [Billing] > [Paid API], the paid usage status for each Paid API can be configured by select [Set] in the [State] column. To enable paid usage, the app must be connected to a Biz Wallet.

Setting	Description
Disabled	Configures the API to not use paid settings.
Enabled	Configures the API to use paid settings. Costs will be charged to the Biz Wallet based on paid usage.

Biz Wallet

In addition to creating and connecting Biz Wallet to apps, detailed information such as business information, payment cards, and administrators can be changed. Only app owners or editors who are also Biz Wallet administrators can manage Biz Wallet.

Create

• Biz Wallet can be created in [My Application] > [Billing] > [Biz Wallet].
• A Biz Wallet must be created with the details of the actual entity responsible for issuing tax invoices.

Connect

• Biz Wallet in an active status can be connected to an app in [My Application] > [Billing] > [Biz Wallet].
• Only Biz Wallet with an associated automatic payment card can be connected to an app.

Change

• The Biz Wallet connected to an app can be changed in [My Application] > [Billing] > [Change / Disconnect Biz Wallet].
• Changes can only be made to Biz Wallet with an associated automatic payment card.

Disconnect

• The connection between an app and a Biz Wallet can be disconnected in [My Application] > [Billing] > [Change / Disconnect Biz Wallet].
• Biz Wallet cannot be disconnected immediately, only a disconnection schedule can be set.
  • Upon scheduling a disconnection, the connection between the app and the Biz Wallet will be removed after automatic payment for the current month’s paid usage is completed following midnight (12:00 AM) the next day.

Invoice

Below is a detailed description of the screen components.

Item	Description
API	Name of the Paid API.
Paid usage	The accumulated paid usage for the current month.
Unit price	Price per unit of paid usage.
Usage amount	The total amount calculated by multiplying paid usage and the unit price.
Total	Sum of the usage amounts for all Paid APIs.
VAT	10% VAT on the total, not reflected in the estimated charge.
Billing amount	Sum of the total and VAT, representing the actual amount billed to the Biz Wallet.