Kakao Connect

To use KakaoTalk or Kakao Sync as a social login provider, you will need an App ID and App Secret from your Kakao app. You’ll then need to copy these keys into your ReachFive settings.

This docs detail how to create a Kakao App and connect it to your ReachFive account.

What profile information is collected by ReachFive?

We are able to retrieve the following information from the user’s KakaoTalk account into their ReachFive account:

KakaoTalk ID
KakaoTalk name
KakaoTalk profile nickname
KakaoTalk username
KakaoTalk profile image
KakaoTalk account email
User’s Birthday (as listed on in KakaoTalk profile)
User’s gender (as listed on in KakaoTalk profile)
User’s phone number (as listed on in KakaoTalk profile)
User phone number verification (whether the user has verified the phone number or not)

You must enable OpenID Connect Activation on your Kakao Login application in order to retrieve the phone_number_verified information.

User’s address

If the user consents to sharing their address upon login with KakaoTalk, ReachFive retrieves the user address information from the user’s KakaoTalk profile.

The following address custom fields must be present in your Addresses object:

kakaotalk_address_id: must be a string data type.
receiver_phone_number2: must be a phone data type.
zone_number: must be a must be a string data type.

Otherwise, no address information is imported.

If you’re creating the custom fields with the Management API: Create address custom field schema, you should value path with these fields:

Example

{
  "path": "kakaotalk_address_id",
  "scope": [
    "string"
  ],
  "name": "kakaotalk_address_id",
  "data_type": "string",
  "id": "kakaotalk_address_id"
}

For more details on the Kakao address, see Kakao’s documentation.

Connecting Information, also known as CI, hosted as part of the provider_metadata object (includes verification and timestamp)

See the provider_metadata object for more details.
Age range for KakaoTalk user. Represented as kakaotalk_age_range.

See the provider_metadata object for more details.
User consents

User consents

You’re able to retrieve user consents collected from the Kakao REST API.

In order to receive the user consents from Kakao into ReachFive, you need to ensure that during integration, ReachFive consents are assigned the opt-in type and that the consent’s key matches the Kakao consent tag. If these things are done correctly, consents are then received when the user logs in using Kakao for the first time.

At time of writing, consents in Kakao are found at Product Settings Kakao Login Simple Signup and are listed as "Terms of Service" and "Consent for age 14 and over".

Connect Kakao with ReachFive

Go to Kakao Developers and log in.
Create a new application or go to your existing Kakao app.
You’ll need to Register a Web platform and add the site and default domain for your application.
```
https://<REACHFIVE_DOMAIN> (1)
```
1 Where <REACHFIVE_DOMAIN> is your domain.
Next, you must activate Kakao Login.
Finally, you’ll need to set your redirect URI with the following:
```
https://<REACHFIVE_DOMAIN>/login/callback (1)
```
1 Where <REACHFIVE_DOMAIN> is your domain.
You must set the state for your scopes inside of the Kakao Developer portal. Otherwise, you won’t be able to retrieve user data.

At time of writing, this is found in Kakao at Product Settings Kakao Login Consent items. Go to the desired scope and set the state to one of the following consent types:
- Required consent: Users must consent to log in with Kakao.
- Optional consent: Kakao login can be completed without users' consent.
After creating your app on Kakao, you’ll need to connect the app to ReachFive, to do so:
1. Get the necessary keys from your Kakao application.
  
  This is typically found in the App Keys section in your Kakao app dashboard.
  
  Kakao ReachFive
  
  REST API key
  
  Client ID
  
  Admin key
  
  Client secret
2. Go Settings Providers KakaoTalk on your ReachFive Console.
3. Paste the REST API key from your Kakao app into the Client ID field in the dialog.
4. Paste the Admin key from your Kakao app into the Client secret field in the dialog.
5. Don’t forget to Save your input.