Legacy JavaScript

This document describes how to integrate Kakao Login APIs into your service with JavaScript SDK v1 (also referred to as 'Legacy JavaScript SDK').

For a Kakao Login button, you can download the resources provided by Kakao or customize buttons according to your service user interface by referring to the Design Guide.

Kakao Login button resource downloadoutlinkDesign Guide

Before you begin

Install SDK

Import the JavaScript SDK v1 into your web page and initialize it by referring to Getting Started > Legacy JavaScript.

Login

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Set Redirect URI Manage consent items Advanced: Activate OpenID Connect(Optional) Set Simple Signup(for Kakao Sync)	Required	Required: Required consent item

The Simple Login functions to authenticate a user through Kakao Talk without inputting the Kakao Account information and get an authorization code. For the Simple Login function, call the Kakao.Auth.authorize() function. If Kakao.Auth.authorize() is invoked by the click event handler, the Consent screen is presented. If a user consents to the provision of their personal information and the use of your service, the Kakao authorization server issues the authorization code to the Redirect URI of the service server with the HTTP response status code 302.

Afterthat, request to get tokens with the obtained authorization code to complete the login. To see how to set or check the Redirect URI, refer to Prerequisites > Set Redirect URI.

To see how to get an authorization code and tokens, refer to REST API.

Parameter

Name	Type	Description	Required
redirectUri	String	A callback URL that the authorization code is redirected to.	O
state	String	If you add this parameter in the request, users are redirected to the page that they were viewing before authentication. If this parameter is included in the request, the same state parameter value with the request is sent to the response.	X
scope	String	Used to request additional consent.	X
throughTalk	Boolean	Whether to use the Simple Login function. (Default: true)	X
prompts	String	Used for additional interactions when requesting an authorization code. - login: Used to request reauthentication by presenting the Kakao Account Login screen to a user regardless of a user's login status to enhance security. - none: Used to use the Auto-login the function. Refer to Sample.	X
nonce	String	Parameter to strengthen security. To prevent replay attacks, generate random strings and pass them as an argument. IMPORTANT: Allowed to set only when you integrate Kakao Login with OpenID Connect.	X

Sample

Kakao.Auth.authorize({
  redirectUri: '${REDIRECT_URI}'
});

Sample: Auto-login

Kakao.Auth.authorize({
  redirectUri: '${REDIRECT_URI}',
  prompts: 'none'
});

Set tokens

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	-	Required	-

When the access token and refresh token are passed in your service server, you can use the tokens to call the Kakao APIs such as Retrieving user information API with the issued tokens. To call other Kakao APIs besides the Login API using the JavaScript SDK v1, you need to assign your tokens into SDK. Call the Kakao.Auth.setAccessToken() function with the access token passed in the login response to set it to use in the JavaScript SDK v1.

Kakao.Auth.setAccessToken(ACCESS_TOKEN);

Logout

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login	Required	-

The Logout API is used to let a user log out of the app. After the user is logged out, you cannot call the Kakao APIs using the corresponding access token because it expires.

Call the Kakao.Auth.logout function in the click event handler invoked when a user clicks [Logout], and then the tokens issued during the login process expire. If the request is successful, implement the process of logging out of a service internally

Sample

if (!Kakao.Auth.getAccessToken()) {
  console.log('Not logged in.');
  return;
}
Kakao.Auth.logout(function() {
  console.log(Kakao.Auth.getAccessToken());
});

Unlink

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login	Required	-

This API unlinks an app from a user's Kakao Account. Call the Kakao.API.request function in the click event handler invoked when a user requests to unlink.

Call the Kakao.API.request() function, and set url to /v1/user/unlink.

Parameter

Name	Type	Description	Required
url	String	Fixed as /v1/user/unlink.	O
success	Function(Object)	Callback function that gets invoked when the API request is successful.	X
fail	Function(Object)	Callback function that gets invoked if the API request is failed.	X
always	Function(Object)	Callback function that gets invoked regardless of API request results.	X

Sample

Kakao.API.request({
  url: '/v1/user/unlink',
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

Retrieve user information

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Manage consent items	Required	Required: All consent items to request user information

This API enables you to retrieve the Kakao Account information of a user who is logged into Kakao. You can request this API by calling a REST API with the kakao.API.request() function. Call the kakao.API.request() function, and set url to /v2/user/me. You can request a specific user information using the property_keys parameter. For the request information, refer to REST API.

The response includes user information and is same as the REST API. Refer to Concepts > User information for more details.

Parameter

Name	Type	Description	Required
url	String	Fixed as /v2/user/me.	O
success	Function(Object)	Callback function that gets invoked when the API request is successful.	X
fail	Function(Object)	Callback function that gets invoked when the API request is failed.	X
always	Function(Object)	Callback function that gets invoked regardless of API request results.	X
data	Object	Object that contains the parameter to be passed when requesting the API. Refer to data: Retrieving user information for more details.	X

data: Retrieving user information

Name	Type	Description	Required
property_keys	String[]	Use this parameter to specify the scopes of user information to be requested in ["key1","key2"] format.	X

Sample

Kakao.API.request({
  url: '/v2/user/me',
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

Sample: Retrieving email and gender

Kakao.API.request({
  url: '/v2/user/me',
  data: {
    property_keys: ["kakao_account.email","kakao_account.gender"]
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

Retrieve shipping address

Basic information

Permission	Prerequisite	Kakao Login	User consent
Required	Register platforms Activate Kakao Login Manage consent items	Required	Required: Shipping information

This API enables you to retrieve shipping addresses saved in user's Kakao Account.

To retrieve shipping address,

• You must enable the 'Shipping information (shipping_address)' scope.
• Users must consent to the scope. If a user does not consent, you cannot get the user data even though you enabled the scope. If Kakao does not retain a user's shipping address, Kakao cannot provide the information to your service even when a user consents.

The shipping_address scope is inactivated by default. To set the scope to 'Optional consent', connect your app to a Biz Channel. If your service must get users' shipping addresses, set the scope to 'Required consent' by going through the Review for Provision of Personal Information provided by Kakao Sync and use the Provision after collecting information option.

Call the Kakao.API.request() function, and set url to /v1/user/shipping_address.

Parameter

Name	Type	Description	Required
url	String	Fixed as '/v1/user/shipping_address'.	O
success	Function(Object)	Callback function that gets invoked when the API request is successful.	X
fail	Function(Object)	Callback function that gets invoked when the API request is failed.	X
always	Function(Object)	Callback function that gets invoked regardless of API request results.	X
data	Object	Object that contains the parameter to be passed when requesting the API. Refer to data: Retrieving shipping address for more details.	X

data: Retrieving shipping address

Name	Type	Description	Required
address_id	Number	If there are multiple shipping addresses, specify an address ID to get a specific shipping address.	X
from_updated_at	Number	If multiple shipping addresses return through multiple pages, only the shipping addresses that are changed after the updated_at time return. The last shipping address on the previous page is used for an input value for the next page. If set to 0, shipping addresses are retrieved from the beginning.	X
page_size	Number	Number of (two or more) shipping addresses displayed on a page. (Default: 10)	X

Sample: Retrieving user's shipping addresses

Kakao.API.request({
  url: '/v1/user/shipping_address',
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

Sample: Retrieving a specific shipping address

Kakao.API.request({
  url: '/v1/user/shipping_address',
  data: {
    address_id: 12345
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

If the request is successful, the user's shipping addresses are returned. For the detailed response fields, refer to REST API > Retrieve shipping address for more details.

Store user information

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Manage user properties	Required	-

This API stores or update additional user information on the Kakao platform to use in a service, which is called 'User properties'. You must use the property keys designated in [My Application] > [Kakao Login] > [User Properties].

You can request this API by calling a REST API with the kakao.API.request() function. Call the Kakao.API.request() function, and set url to /v1/user/update_profile. You must pass the custom property keys and values that you want to upadate through properties in a key-value pair. For example, if you want to update a user's clothing size, set properties to clothing_size: 'small'.

If the request is successful, the service user ID requested to update information is returned in the same way as the REST API. To check the updated user information, call the Retrieving user information API.

Parameter

Name	Type	Description	Required
url	String	Fixed as '/v1/user/update_profile'.	O
success	Function(Object)	Callback function that gets invoked when the API request is successful.	X
fail	Function(Object)	Callback function that gets invoked when the API request is failed.	X
always	Function(Object)	Callback function that gets invoked regardless of API request results.	X
data	Object	Object that contains the parameter to be passed when requesting the API. Refer to data: Storing user information for more details.	X

data: Storing user information

Name	Type	Description	Required
properties	Object	User information that you want to update in {key:value} format.	O

Sample

Kakao.API.request({
  url: '/v1/user/update_profile',
  data: {
    properties: {
      '${CUSTOM_PROPERTY_KEY}': '${CUSTOM_PROPERTY_VALUE}'
    },
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

Request additional consent

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Set Redirect URI Manage consent items Manage consent items Advanced: Activate OpenID Connect(Optional) Set Simple Signup(for Kakao Sync)	Required	Required: Required consent item

This API prompts the Consent screen to request additional permission or specific personal information for the service if the user has not agreed once logging in with Kakao. Before using this API, read Concepts > Request additional consent thoroughly for a better understanding.

Call the authorize() function that requests an authorization code with the scopes you want to request consent through the scope parameter.

Parameter

Name	Type	Description	Required
redirectUri	String	URI to get the authorization code.	O
scope	String	Scope ID of the User information you want to request additional consent. You can pass multiple scopes by separating by comma(,) as a string without space. You can figure out each scope's ID in [My Application] > [Kakao Login] > [Consent Items]. (Example: 'scope: 'account_email,gender') IMPORTANT: If you implement OpenID Connect (OIDC), you must add openid to scope along with the scope values you want to obtain consent. If not, OAuth is enabled even though you enabled OIDC. (Example: scope: 'openid,account_email,gender')	O
state	String	Parameters to be maintained during the login process.	X
nonce	String	Parameter to strengthen security. To prevent replay attacks, generate random strings and pass them as an argument. IMPORTANT: Allowed to set only when you integrate Kakao Login with OpenID Connect.	X

The response is the same as the response of Getting authorization code API. If the request is successful, the Consent screen that includes the requested scope as a consent item is presented. When a user selects [Accept and Continue] on the Consent screen, the request is successfully completed. If the user selects [Cancel], the request is failed.

Sample: Request additional consent through OAuth protocol

Here is an example of requesting additional consent by passing the scopes of email and gender when calling authorize().

Kakao.Auth.authorize({
  redirectUri: 'https://developers.kakao.com/kakaoLogin.jsp',
  scope: 'account_email,gender'
});

Sample: Request additional consent through OIDC protocol

Kakao.Auth.authorize({
  redirectUri: 'https://developers.kakao.com/kakaoLogin.jsp',
  scope: 'openid,account_email,gender'
});

Sample: Request with the Kakao.Auth.login function

If you want to present the Consent screen as a pop-up window or the client handles all authentication processes, call Kakao.Auth.login().

Kakao.Auth.login({
  scope: 'account_email,gender',
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

Retrieve consent details

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Manage consent items	Required	-

This API enables you to retrieve the detailed information of the scopes (consent items) that a user has agreed to. You can check all scopes set in [My Application] > [Kakao Login] > [Consent Items] and the details of the scopes. If a user has consented to the scope before, the scope is included in the response even though your app is currently not using the scope.

Call the Kakao.API.request() function, and set url to /v2/user/scopes. You can also designate the scopes you want to check the details by specifying the scopes parameter. If the request is successful, the response includes only the detailed information of the specified scopes in the same way as the REST API. Refer to REST API > Retrieve consent details for more details.

Parameter

Name	Type	Description	Required
url	String	Fixed as /v2/user/scopes.	O
success	Function(Object)	Callback function that gets invoked when the API request is successful.	X
fail	Function(Object)	Callback function that gets invoked when the API request is failed.	X
always	Function(Object)	Callback function that gets invoked regardless of API request results.	X
data	Object	Object that contains the parameters to be passed when requesting the API. Refer to data: Retrieving consent details for more details.	X

data: Retrieving consent details

Name	Type	Description	Required
scopes	String[]	Used when you retrieve specific scopes only. List of scope IDs you want to retrieve. You can figure out each scope's ID in [My Application] > [Kakao Login] > [Consent Items]. (Example: ["account_email","gender"])	X

Sample

Kakao.API.request({
  url: '/v2/user/scopes',
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

Sample: Checking the details of Email and gender scopes

Kakao.API.request({
  url: '/v2/user/scopes',
  data: {
    scopes: ["account_email","gender"]
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

Revoke consent

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Manage consent items	Required	-

This API revokes the scope that a user has agreed to. You can only revoke the scope with "revocable":true among the scopes retrieved through the Retrieving consent details API. If you request to revoke the scope that is not revocable, an error is returned.

Call the Kakao.API.request() function, and set url to /v2/user/revoke/scopes. The response is the same as the response of Retrieving consent details API. Refer to REST API > Revoking consent details.

Parameter

Name	Type	Description	Required
url	String	Fixed as /v2/user/revoke/scopes.	O
success	Function(Object)	Callback function that gets invoked when the API request is successful.	X
fail	Function(Object)	Callback function that gets invoked when the API request is failed.	X
always	Function(Object)	Callback function that gets invoked regardless of API request results.	X
data	Object	Object that contains the parameters to be passed when requesting the API. Refer to data: Revoking consent for more details.	O

data: Revoking consent

Name	Type	Description	Required
scopes	String[]	List of scope IDs you want to revoke. You can revoke only the scope with "revocable":true among the scopes retrieved through the Retrieving consent details API. You can figure out each scope's ID in [My Application] > [Kakao Login] > [Consent Items]. (Example: ["account_email","gender"])	O

Sample

Kakao.API.request({
  url: '/v2/user/revoke/scopes',
  data: {
    scopes: ["account_email","gender"]
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

Retrieve consent details for service terms

Basic information

Permission	Prerequisite	Kakao Login	User consent
Required	Register platforms Activate Kakao Login Manage consent items Set Simple Signup	Required	-

This API enables you to check the service terms that a user has consented to. You can request this API by calling a REST API with the kakao.API.request() function. Call the kakao.API.request() function, and set url to /v1/user/service/terms.

Parameter

Name	Type	Description	Required
url	String	Fixed as /v1/user/service/terms.	O
success	Function(Object)	Callback function that gets invoked when the API request is successful.	X
fail	Function(Object)	Callback function that gets invoked when the API request is failed.	X
always	Function(Object)	Callback function that gets invoked regardless of API request results.	X
data	Object	Object that contains the parameter to be passed when requesting the API. Refer to data: Retrieving consent details for service terms for more details.	X

data: Retrieving consent details for service terms

Name	Type	Description	Required
extra	String	Used to retrieve all of the terms registered in your app. In this case, set it to app_service_terms.	X

Sample

Kakao.API.request({
  url: '/v1/user/service/terms',
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

Sample: Requesting all terms registered in app

Kakao.API.request({
  url: '/v1/user/service/terms',
  data: {
    extra: 'app_service_terms'
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

If the request is successful, the information of the service terms to which a user consented to is returned in the same as the REST API.

Get consent to desired service terms

Basic information

Permission	Prerequisite	Kakao Login	User consent
Required	Register platforms Activate Kakao Login Set Redirect URI Manage consent items Manage consent items Advanced: Activate OpenID Connect(Optional) Set Simple Signup	Required	Required: Required consent item

This API enables you to request consent to specific service terms that a user has not consented to, regardless of whether the user has already signed up.

If your app is used for multiple services and each service requires consent to different terms, or if a new required term is added to your service, you can use this API. For more details, Design service terms and policies.

Pass serviceTerms to the authorize() method as a parameter. Make sure to include all tags of the service terms needed to get consent in a single String format by separating respective tags by comma(,).

If the request is successful, an authorization code is returned in the same way as the REST API. If the Consent screen is not prompted even after calling this API, refer to FAQ.

Parameter

Name	Type	Description	Required
redirectUri	String	The URI used to get an authorization code.	O
serviceTerms	Sting[]	Tags for the terms needed to get consent. Tags should be in a single string format by separating respective tags by comma(,).	O

Sample

Kakao.Auth.authorize({
 redirectUri: '${REDIRECT_URI}',
 serviceTerms: 'tag1,tag2'
});

Advanced: Login by presenting popup consent screen

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Manage consent items Advanced: Activate OpenID Connect(Optional) Set Simple Signup(for Kakao Sync)	Required	Required: Required consent item

If you need to display the Consent screen as a pop-up window or if the whole authentication should be completed from the client-side, use the Kakao.Auth.login() function.

If you call this function in the click event handler, you can present the Kakao Login Consent screen and then get consent to provide user information and use of the service from users.

If the login request is successful, an access token is issued. Because the access token is used internally in the SDK, you do not need to process it separately. However, you need to process a login or signup process in your service for a user who succeeded in logging in using the success callback function.

Parameter

Name	Type	Description	Required
success	Function(Object)	Callback function that gets invoked when the API request is successful. For the response, refer to the REST API > Getting tokens.	X
fail	Function(Object)	Callback function that gets invoked when the API request is failed.	X
always	Function(Object)	Callback function that gets invoked regardless of API request results.	X
scope	String	Used to request additional consent. Pass the scope IDs of the User information. You can figure out each scope's ID in [My Application] > [Kakao Login] > [Consent Items]. For multiple scopes, separate them by comma(,) as a string without space. (Example: 'account_email,gender') IMPORTANT: If you implement OpenID Connect (OIDC), you must add openid to scope along with the scope values you want to obtain consent. If not, OAuth is enabled even though you enabled OIDC. (Example: scope: 'openid,account_email,gender')	X
persistAccessToken	Boolean	Stores the access token in the local storage to use it even after the session ends. (Default: true)	X
throughTalk	Boolean	Whether to use the Simple Login function. (Default: true)	X
nonce	String	Parameter to strengthen security. To prevent replay attacks, generate random strings and pass them as an argument. IMPORTANT: Allowed to set only when you integrate Kakao Login with OpenID Connect and pass scope.	X

Sample

Kakao.Auth.login({
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

Sample: createLoginButton

This example shows how to add an event handler to the Kakao Login button using createLoginButton.

Kakao.Auth.createLoginButton({
  container: '${CONTAINER_ID}',
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

Advanced: Manual signup

Basic information

Permission	Prerequisite	Kakao Login	User consent
Required	Register platforms Activate Kakao Login	Required	-

The Manual signup API manually links a user with your app to complete signup when the Auto-link is disabled. To figure out if the currently logged-in user needs to be linked with your app, check the value of has_signed_up in the response of the Retrieving user information API and handle each case:

• true: The user is already linked with your app. You do not need to call the Manual signup API.
• false: The user is not linked with your app. You must link the user with your app manually.
• null: Your app is using the Auto-link feature. You do not need to call the Manual signup API.

Call the Kakao.API.request() function, and set url to /v1/user/signup. If you want to store the user's information when the user is linked to your app, pass properties in data.

If the request is successful, id is returned in the same way as the REST API. Refer to REST API > Advanced: Manual signup for more details.

Because the Manual signup API only returns the service user ID if successful, call the Retrieving user information API again and see the value of has_signed_up and properties to check the request result in detail.

Parameter

Name	Type	Description	Required
url	String	Fixed as /v1/user/signup.	O
success	Function(Object)	Callback function that gets invoked when the API request is successful.	X
fail	Function(Object)	Callback function that gets invoked if the API request is failed.	X
always	Function(Object)	Callback function that gets invoked regardless of API request results.	X
data	Object	Object that contains the parameter to be passed when requesting the API. Refer to data: Manual signup for more details.	X

data: Manual signup

Name	Type	Description	Required
properties	Object	Used when you want to store user properties when linking a user. (Example: {key:value}) Refer to Manage user properties and Store user information.	X

Sample

Kakao.API.request({
  url: '/v1/user/signup',
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
});

Sample: Manual signup and update additional information

Kakao.API.request({
  url: '/v1/user/signup',
  data: {
    properties: {
      '${CUSTOM_PROPERTY_KEY}': '${CUSTOM_PROPERTY_VALUE}'
    },
  },
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  }
});

See more

• Download JavaScript SDK v1
• API Reference for JavaScript SDK v1 →