본문 바로가기메인 메뉴 바로가기사이드 메뉴 바로가기

kakao developers

관련사이트

사이드 메뉴

플랫폼 API

API 제공

전용 API

어드민 API

이 문서는 카카오 또는 공동체 서비스용 카카오계정 관리 API 사용 방법을 안내합니다.

메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v1/internal/account
공동체
https://kapi.kakao.com/v1/internal/account
서비스 앱 어드민 키

카카오계정의 카카오디벨로퍼스 개발자 정보와 연결된 앱 정보를 가져옵니다. 개발자 정보는 카카오디벨로퍼스에 개발자 계정으로 등록된 경우에만 존재합니다.

이 API는 카카오계정 시스템에서 아래 용도로 사용합니다.

  • 사용자의 카카오계정 직접 탈퇴, 또는 어드민의 카카오계정 탈퇴 처리 시 아래 목적으로 호출
    • 연결된 앱이 있는지 확인
    • 디지털카드 발급 여부 확인 (platform.name=DIGITAL_CARD)
    • 카카오계정의 다음회원 연결 또는 통합 여부 확인 (project.total_count)

헤더에 카카오계정 시스템 앱의 어드민 키를 담아 GET으로 요청합니다. 요청 시 조회 대상 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오계정의 개발자 정보, 연결된 앱 정보가 담긴 JSON 객체를 포함합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
이름타입설명필수
developerDeveloperDefaultWithOwnApps카카오계정의 개발자 계정 정보와 소유한 앱 정보X
usersUserDefaultInfo카카오계정과 연결된 앱 정보X
projectProject카카오계정의 다음회원 연결 또는 통합 정보X
platformsPlatform[]카카오계정과 연결된 플랫폼 서비스 정보X
이름타입설명필수
idInteger개발자 계정 IDO
registered_atString개발자 계정 가입 시각, RFC3339 internet date/time 형식O
deactivatedBoolean개발자 계정이 장기 휴면 또는 CS 등으로 카카오계정 어드민에서 탈퇴된 경우, 서비스에 영향을 주기 않기 위해 탈퇴된 상태로 소유자(OWNER) 정보가 남으며, 이 경우에만 true 값으로 제공O
own_appsAppsDefaultInfo개발자 계정이 소유한 앱 정보X
이름타입설명필수
total_countInteger개발자 계정이 소유한 앱 수O
이름타입설명필수
total_countInteger카카오계정과 연결 또는 연결 대기 상태인 앱 수O
이름타입설명필수
total_countInteger카카오계정과 연결 또는 통합된 다음회원 수X
이름타입설명필수
nameString플랫폼 서비스 이름
DIGITAL_CARD: 디지털 카드
O
total_countInteger해당 플랫폼 서비스 내에서 카카오계정과 연결 또는 연결 대기 상태인 앱 수O
  • 파라미터
    • 카카오계정 ID(account_id)
curl -v -G GET "http://kapi.kakao.com/v1/internal/account" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2137162"
// HTTP/1.1 200 OK
{
"developer": {
"id": 576952,
"registered_at": "2020-02-17T06:43:02Z",
"deactivated": false,
"own_apps": {
"total_count": 8
}
},
"users": {
"total_count": 11
},
"projects": {
"total_count": 1
},
"platforms": [
{
"name": "DIGITAL_CARD",
"total_count": 1
}
]
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v3/internal/account/apps
공동체
https://kapi.kakao.com/v3/internal/account/apps
서비스 앱 어드민 키

카카오계정에 연결된 활성화 상태의 앱 목록을 가져옵니다. 이 API는 연결된 서비스 관리에서 사용합니다.

헤더에 앱 어드민 키를 담아 GET으로 요청합니다. 요청 시 조회 대상 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오계정에 연결된 앱 목록을 포함합니다. 연결된 앱 정보는 연결 시각 순으로 정렬됩니다.

2024년 5월 7일부터 연결된 앱 정보 조회 API가 연결된 앱 목록 조회, 연결된 앱 상세 정보 조회로 나뉘어 제공됩니다. 기존 버전인 /v2/internal/account/users의 정보는 별도 문서에서 확인할 수 있습니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
app_typesString앱 타입 필터, 쉼표로 구분된 하나의 문자열로 전달

KAKAO
DAUM
PARTNER
DEFAULT
X
limitInteger페이지당 결과 수
(기본값: 5)
X
이름타입설명필수
elementsRegisteredApp[]연결된 활성화 상태의 앱 목록O
after_urlString다음 페이지 요청 URLX
이름타입설명필수
user_idLong회원번호O
registered_atString연결 시각, RFC3339 internet date/time 형식O
appAppDefault연결된 앱 기본 정보O
이름타입설명필수
idInteger앱 IDO
nameString앱 이름O
typeString앱 타입O
categoryString앱 카테고리O
companyString회사명O
secure_icon_image_urlString앱 아이콘 이미지 URL, HTTPSO
  • 파라미터
    • 카카오계정 ID(account_id)
    • 앱 타입 필터(app_types): 제휴 앱, 일반 앱
    • 페이지당 결과 수(limit): 3
curl -v -G "http://kapi.kakao.com/v3/internal/account/apps" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2137100" \
-d "app_types=PARTNER,DEFAULT" \
-d "limit=3"
// HTTP/1.1 200 OK
{
"elements": [
{
"user_id": 1376016924431927711,
"registered_at": "2024-03-20T06:33:38Z",
"app": {
"id": 1432510,
"name": "pandoro",
"company": "pandoro",
"type": "DEFAULT",
"category": "Art_Design",
"secure_icon_image_url": "https://k.kakaocdn.net/14/dn/ZSmo8YOYKm/DRxKAkNTRiq8danidTwnJK/o.jpg"
}
}
// ...
],
"after_url": "http://kapi.kakao.com/v3/internal/account/apps?account_id=2137100&from_id=1637139612000&app_types=PARTNER%2CDEFAULT&order=desc"
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v3/internal/account/app
공동체
https://kapi.kakao.com/v3/internal/account/app
서비스 앱 어드민 키

카카오계정에 연결된 활성화 상태의 앱 상세 정보를 가져옵니다. 이 API는 연결된 서비스 관리에서 사용합니다.

헤더에 앱 어드민 키를 담아 GET으로 요청합니다. 요청 시 조회 대상 카카오계정과 앱의 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오계정에 연결된 앱의 상세 정보를 포함합니다. 조회 대상 카카오계정과 앱이 연결되어 있지 않은 경우, 응답 본문은 비어 있습니다.

2024년 5월 7일부터 연결된 앱 정보 조회 API가 연결된 앱 목록 조회, 연결된 앱 상세 정보 조회로 나뉘어 제공됩니다. 기존 버전인 /v2/internal/account/users의 정보는 별도 문서에서 확인할 수 있습니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
app_idLong앱 IDO
localeString응답 언어
(기본값: en)
X
이름타입설명필수
user_idLong회원번호O
registered_atString연결 시각, RFC3339 internet date/time 형식O
agreed_scopesAgreedScope[]카카오계정의 사용자가 동의한 앱의 동의항목 목록O
allowed_msgBoolean메시지 수신 허용 여부O
appAppDetail앱 상세 정보O
이름타입설명필수
idString동의항목 IDO
displayString동의항목 이름O
scope_typeString동의항목 타입, 아래 중 하나
  • PRIVACY: 개인정보
  • SERVICE: 접근권한
O
requiredBoolean필수 동의항목 여부O
이름타입설명필수
idInteger앱 IDO
nameString앱 이름O
typeString앱 타입O
categoryString앱 카테고리O
companyString회사명O
secure_icon_image_urlString앱 아이콘 이미지 URL, HTTPSO
execution_urlExecutionUrl[]실행 URLO
market_urlMarketUrl[]스토어 URLO
이름타입설명필수
platformString플랫폼 이름, 아래 중 하나
  • android
  • ios
  • web
X
pkgnamesString[]android 패키지 이름 목록X
urlStringios 앱 실행 URLX
urlsString[]web 웹 또는 앱 실행 URL 목록X
이름타입설명필수
platformString플랫폼 이름, 아래 중 하나
  • android
  • ios
X
urlStringios 스토어 URLX
urlsString[]android 스토어 URLX
  • 파라미터
    • 카카오계정 ID(account_id)
    • 앱 ID(app_id)
    • 응답 언어(locale): 한국어(ko)
curl -v -G "http://kapi.kakao.com/v3/internal/account/app" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2137100" \
-d "app_id=977000" \
-d "locale=ko"
// HTTP/1.1 200 OK
{
"user_id": 1376016924429759243,
"registered_at": "2023-12-01T05:59:16Z",
"agreed_scopes": [
{
"id": "account_email",
"display": "카카오계정(이메일)",
"scope_type": "PRIVACY",
"required": true
},
{
"id": "name",
"display": "이름",
"scope_type": "PRIVACY",
"required": true
},
{
"id": "talk_message",
"display": "카카오톡 메시지 전송",
"scope_type": "SERVICE",
"required": true
},
{
"id": "talk_schedule",
"display": "카카오톡 일정 등록",
"scope_type": "SERVICE",
"required": false
}
// ...
],
"allowed_msg": true,
"app": {
"id": 977000,
"name": "Sample",
"company": "SampleCompany",
"type": "KAKAO",
"category": "Social",
"secure_icon_image_url": "https://k.kakaocdn.net/14/dn/ZSmnVFda0T/bMf80RcKup9RtkHcFdcsj0/o.jpg",
"execution_url": [
{
"platform": "android",
"pkgnames": ["com.kakao.original"]
},
{
"platform": "iOS",
"url": "kakao${NATIVE_APP_KEY}://"
},
{
"platform": "web",
"urls": ["https://developers.kakao.com", "https://devtalk.kakao.com", "http://www.nytimes.com"]
}
],
"market_url": [
{
"platform": "android",
"urls": ["market://details?id=com.kakao.original"]
},
{
"platform": "iOS",
"url": "https://itunes.apple.com/app/id123456"
}
]
}
}
// HTTP/1.1 200 OK
{
"user_id": 1376016924429923827,
"registered_at": "2024-05-08T06:38:15Z",
"agreed_scopes": [],
"app": {
"id": 1102200,
"name": "Sample",
"company": "Sample",
"type": "SAMPLE",
"category": "None",
"secure_icon_image_url": "https://k.kakaocdn.net/14/dn/ZSf7XoXJ6O/zYZd5dqCAZBZtf528ORXz1/o.jpg",
"execution_url": [],
"market_url": []
}
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v3/internal/account/deregistered/apps
공동체
https://kapi.kakao.com/v3/internal/account/deregistered/apps
서비스 앱 어드민 키

카카오계정에서 연결 해제된 활성화 상태의 앱 목록을 가져옵니다. 이 API는 연결된 서비스 관리에서 사용합니다.

헤더에 앱 어드민 키를 담아 GET으로 요청합니다. 요청 시 조회 대상 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오계정에서 연결 해제된 앱 정보 목록을 포함합니다.

2024년 5월 7일부터 연결 해제된 앱 정보 조회 API를, 연결 해제된 앱 목록 조회 API와 연결 해제된 앱 상세 정보 조회 API로 제공합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
app_typesString앱 타입 필터, 쉼표로 구분된 하나의 문자열로 전달

KAKAO
DAUM
PARTNER
DEFAULT
X
limitInteger페이지당 결과 수
(기본값: 5)
X
이름타입설명필수
elementsDeregisteredApp[]연결 해제된 활성화 상태의 앱 목록O
after_urlString다음 페이지 요청 URLX
이름타입설명필수
user_idLong회원번호O
deregistered_atString연결 해제 시각, RFC3339 internet date/time 형식O
displayableBoolean연결 해제된 앱 목록에서 앱의 표시 여부, true로 고정
  • true: 표시됨
  • false: 표시되지 않음
O
appAppDefault연결 해제된 앱 기본 정보O
  • 파라미터
    • 카카오계정 ID(account_id)
    • 앱 타입(app_types): 인하우스 앱(KAKAO,DAUM)
    • 페이지당 결과 수(limit): 2
curl -v -G "http://kapi.kakao.com/v3/internal/account/deregistered/apps" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2137100" \
-d "app_types=KAKAO,DAUM" \
-d "limit=2"
// HTTP/1.1 200 OK
{
"elements": [
{
"user_id": 1376016924430812661,
"deregistered_at": "2023-12-01T06:00:33Z",
"displayable": true,
"app": {
"id": 1090123,
"name": "DelegationTest",
"company": "Test",
"type": "KAKAO",
"category": "None",
"secure_icon_image_url": "https://k.kakaocdn.net/14/dn/ZSf4YVJIda/Ca5Qb1NsqUgTtNAt0oYTeK/o.jpg"
}
}
],
"after_url": null
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v3/internal/account/deregistered/app
공동체
https://kapi.kakao.com/v3/internal/account/deregistered/app
서비스 앱 어드민 키

카카오계정에서 연결 해제된 활성화 상태 앱의 상세 정보를 가져옵니다. 이 API는 연결된 서비스 관리에서 사용합니다.

헤더에 앱 어드민 키를 담아 GET으로 요청합니다. 요청 시 조회 대상 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오계정에서 연결 해제된 특정 앱의 상세 정보입니다.

2024년 5월 7일부터 연결 해제된 앱 정보 조회 API를, 연결 해제된 앱 목록 조회 API와 연결 해제된 앱 상세 정보 조회 API로 제공합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
app_idLong앱 IDO
이름타입설명필수
user_idLong회원번호O
registered_atString연결 시각, RFC3339 internet date/time 형식X
deregistered_atString연결 해제 시각, RFC3339 internet date/time 형식O
deregistered_byString연결 해제 사유, 아래 중 하나
  • ACCOUNT_DELETE: 카카오계정 탈퇴
  • FORCED_ACCOUNT_DELETE: 장기 휴면 또는 고객센터에서 카카오계정 강제 탈퇴
  • UNLINK_FROM_ADMIN: 카카오 관리자로 인한 탈퇴 처리
  • UNLINK_FROM_APPS: 카카오계정 페이지에서 서비스 연결 해제
  • UNLINK_FROM_SERVICE: 서비스에서 연결 해제
  • REVOKE_ACCOUNT_SERVICE_TERMS: 통합서비스 약관 철회
X
displayableBoolean연결 해제된 앱 목록에서 앱의 표시 여부, true로 고정
  • true: 표시됨
  • false: 표시되지 않음
O
deregistered_fromString연결 해제한 사용자의 UserAgent 정보X
appAppDetail앱 상세 정보O
  • 파라미터
    • 카카오계정 ID(account_id)
    • 앱 ID(app_id)
curl -v -G "http://kapi.kakao.com/v3/internal/account/deregistered/app" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2137100" \
-d "app_id=1090100"
// HTTP/1.1 200 OK
{
"user_id": 1376016924430812661,
"registered_at": "2024-05-08T07:27:28Z",
"deregistered_at": "2024-05-08T07:42:36Z",
"deregistered_by": "UNLINK_FROM_SERVICE",
"displayable": true,
"app": {
"id": 1090100,
"name": "DelegationTest",
"company": "Test",
"type": "KAKAO",
"category": "None",
"secure_icon_image_url": "${ICON_IMAGE_URL}",
"execution_url": [
{
"platform": "android",
"pkgnames": ["com.sample.test"]
},
{
"platform": "iOS",
"url": "kakao${NATIVE_APP_KEY}://"
},
{
"platform": "web",
"urls": ["http://www.nytimes.com"]
}
],
"market_url": [
{
"platform": "android",
"urls": ["market://details?id=com.sample.test"]
},
{
"platform": "iOS",
"url": "https://itunes.apple.com/app/id123456"
}
]
}
}
메서드URL인증 방식
POST/DELETE카카오
http://kapi.kakao.com/v3/internal/account/deregistered/app/delete
공동체
https://kapi.kakao.com/v3/internal/account/deregistered/app/delete
서비스 앱 어드민 키

카카오계정의 연결 해제된 앱 목록에서, 특정 앱을 삭제합니다. 이 API는 연결된 서비스 관리에서 사용합니다. 연결 해제된 앱 목록에서 삭제된 앱은, 연결 해제된 앱 목록 조회 API 또는 연결 해제된 앱 상세 정보 조회 API로 조회할 수 없습니다.

헤더에 앱 어드민 키를 담아 POST 또는 DELETE로 요청합니다. 요청 시 삭제 대상 카카오계정 ID와 앱 ID를 전달해야 합니다.

요청 성공 시 응답은, 연결 해제된 앱 목록에서 삭제된 앱 정보를 포함합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
app_idLong앱 IDO
이름타입설명필수
user_idLong회원번호O
registered_atString연결 시각, RFC3339 internet date/time 형식X
deregistered_atString연결 해제 시각, RFC3339 internet date/time 형식O
deregistered_byString연결 해제 사유, 아래 중 하나
  • ACCOUNT_DELETE: 카카오계정 탈퇴
  • FORCED_ACCOUNT_DELETE: 장기 휴면 또는 고객센터에서 카카오계정 강제 탈퇴
  • UNLINK_FROM_ADMIN: 카카오 관리자로 인한 탈퇴 처리
  • UNLINK_FROM_APPS: 카카오계정 페이지에서 서비스 연결 해제
  • UNLINK_FROM_SERVICE: 서비스에서 연결 해제
  • REVOKE_ACCOUNT_SERVICE_TERMS: 통합서비스 약관 철회
X
displayableBoolean연결 해제된 앱 목록에서 앱의 표시 여부, 요청 성공 시 false로 응답
  • true: 표시됨
  • false: 표시되지 않음
O
hidden_atString연결 해제된 앱 목록에서 앱이 삭제된 시각, RFC3339 internet date/time 형식O
deregistered_fromString연결 해제한 사용자의 UserAgent 정보X
appAppDetail앱 상세 정보O
  • 파라미터
    • 카카오계정 ID(account_id)
    • 앱 ID(app_id)
curl -v -X POST "http://kapi.kakao.com/v3/internal/account/deregistered/app/delete" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2137100" \
-d "app_id=1090100"
// HTTP/1.1 200 OK
{
"user_id": 1376016924430812661,
"registered_at": "2024-05-08T07:27:28Z",
"deregistered_at": "2024-05-08T07:42:36Z",
"deregistered_by": "UNLINK_FROM_SERVICE",
"displayable": false,
"hidden_at": "2025-09-11T02:01:45",
"app": {
"id": 1090100,
"name": "DelegationTest",
"company": "Test",
"type": "KAKAO",
"category": "None",
"secure_icon_image_url": "${ICON_IMAGE_URL}",
"execution_url": [
{
"platform": "android",
"pkgnames": ["com.sample.test"]
},
{
"platform": "iOS",
"url": "kakao${NATIVE_APP_KEY}://"
},
{
"platform": "web",
"urls": ["http://www.nytimes.com"]
}
],
"market_url": [
{
"platform": "android",
"urls": ["market://details?id=com.sample.test"]
},
{
"platform": "iOS",
"url": "https://itunes.apple.com/app/id123456"
}
]
}
}
메서드URL인증 방식
POST카카오
http://kapi.kakao.com/v1/internal/account/logoutall
공동체
https://kapi.kakao.com/v1/internal/account/logoutall
서비스 앱 어드민 키

카카오계정을 연결된 모든 앱에서 로그아웃 처리합니다. 수동 로그아웃 처리 시 각 앱에서 카카오 로그인으로 발급받은 토큰이 모두 만료됩니다.

헤더에 카카오계정 시스템 앱의 어드민 키를 담아 POST로 요청합니다. 요청 시 대상 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오계정과 연결된 앱 중 영향받은 앱 수를 포함합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
이름타입설명필수
affected_usersInteger영향받은 사용자 수
해당 카카오계정이 연결 또는 연결 대기인 앱 수
O
  • 파라미터
    • 카카오계정 ID(account_id)
curl -v -X POST "http://kapi.kakao.com/v1/internal/account/logoutall" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2350171"
// HTTP/1.1 200 OK
{
"affected_users": 2
}
메서드URL인증 방식
POST카카오
http://kapi.kakao.com/v1/internal/account/parent_agreement
공동체
https://kapi.kakao.com/v1/internal/account/parent_agreement
서비스 앱 어드민 키

카카오계정의 보호자 동의 완료 시, 만 14세 미만 차단 앱에서 로그아웃 처리합니다. 카카오계정이 보호자 동의 절차를 완료했을 때, 모든 14세 미만 차단 앱에서 로그아웃 처리해 다시 로그인하도록 하기 위해 사용합니다. 이 API는 만 14세 미만 차단 기능을 사용하는 카카오 로그인 사용 앱 대상으로만 동작합니다.

헤더에 카카오계정 시스템 앱의 어드민 키를 담아 POST로 요청합니다. 요청 시 대상 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오계정과 연결된 앱 중 영향받은 앱 수를 포함합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
이름타입설명필수
affected_usersInteger영향받은 사용자 수O
  • 파라미터
    • 카카오계정 ID(account_id)
curl -v -X POST "http://kapi.kakao.com/v1/internal/account/parent_agreement" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2350171"
// HTTP/1.1 200 OK
{
"affected_users": 1
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v2/internal/account/app/unlinkable
공동체
https://kapi.kakao.com/v2/internal/account/app/unlinkable
위임

카카오계정과 연결된 특정 서비스 앱에서 연결 해제가 가능한지 확인합니다. 이 API는 연결된 서비스 관리에서 사용자가 특정 앱에 대해 [연결 해제]를 요청할 때 호출됩니다. 응답의 (can_unlink) 값에 따른 동작은 아래와 같습니다.

  • 연결 해제 가능(can_unlink=true)
    • 특정 앱과 연결 해제 요청에 필요한 연결 해제 토큰(unlink_token) 발급
    • 연결 해제 웹훅이 설정된 서비스 앱인 경우
      • 특정 앱과 연결 해제 요청 가능, 서비스에 개인정보 및 이용 기록 삭제 요청 가능
      • 지정된 문구로 연결 해제 가능 여부 사용자 재확인, 예제 참고
      • 사용자 확인 및 동의 후 unlink_token 값으로 특정 앱과 연결 해제 요청, 서비스에 개인정보 및 이용 기록 삭제가 연결 해제 웹훅으로 요청됨
    • 연결 해제 웹훅이 설정되지 않은 서비스 앱인 경우
      • 특정 앱과 연결 해제 요청 가능, 서비스에 개인정보 및 이용 기록 삭제 요청 불가능
      • 개인정보와 이용 기록 삭제는 사용자가 직접 서비스에서 탈퇴 절차가 필요함을 지정된 문구로 안내, 예제 참고
      • 사용자 확인 및 동의 후 unlink_token 값으로 특정 앱과 연결 해제 요청
  • 연결 해제 불가능(can_unlink=false)
    • 특정 앱과 연결 해제 요청 불가능, 서비스에 개인정보 및 이용 기록 삭제 요청 불가능
    • 해당 앱과 연결 해제 및 개인정보와 이용 기록 삭제를 위해 사용자가 직접 서비스에서 탈퇴 절차가 필요함을 지정된 문구로 안내, 예제 참고

헤더에 카카오계정 시스템 앱의 어드민 키를 담아 GET으로 요청합니다. 요청 시 대상 앱 ID와 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 연결 해제 가능 여부, 연결 해제 안내 문구, 연결 해제 토큰을 포함합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${DELEGATOR_APP_ADMIN_KEY}
인증 방식, 플랫폼 앱 어드민 키로 인증 요청
서비스 앱의 권한을 플랫폼 앱이 위임받아 요청하는 방식으로 내부 API 요청 시 사용 가능
서비스 구분을 위해 서비스 앱의 앱 ID, 앱 키, 토큰 중 하나 파라미터로 전달 필요
O
이름타입설명필수
target_app_idLong서비스 앱의 IDO
account_idInteger카카오계정 IDO
referrer_typeString연결 해제 경로, 아래 중 하나
  • UNLINK_FROM_APPS: 연결된 서비스 관리에서의 연결 해제
  • UNLINK_FROM_ADMIN: CS로 인한 연결 해제 처리
O
localeString연결 해제 안내 문구의 언어 지정, 아래 중 하나
  • KO: 한국어
  • EN: 영어
  • JA: 일본어
  • zh-CN: 중국어(간체)
  • zh-TW: 중국어(번체)
  • AR: 아랍어
  • DE: 독일어
  • ES: 스페인어
  • FR: 프랑스어
  • IN: 인도네시아어
  • IT: 이탈리아어
  • PT: 포르투갈어
  • RU: 러시사어
  • TH: 태국어
  • TR: 터키어
  • VI: 베트남어
(기본값: KO)
X
이름타입설명필수
user_idLong회원번호O
can_unlinkBoolean연결 해제 가능 여부
  • true: 가능
  • false: 불가
O
titleString연결 해제 버튼 클릭시 팝업의 안내 문구 제목O
messageString연결 해제 버튼 클릭시 팝업의 안내 문구 메시지O
button_labelString연결 해제 버튼 클릭시 팝업의 확인 버튼 이름O
unlink_tokenString연결 해제 요청에 사용할 연결 해제 토큰

중요: can_unlink 값이 true인 경우 응답에 포함
X
  • 파라미터
    • 앱 ID(target_app_id)
    • 카카오계정 ID(account_id)
    • 연결 해제 경로(referrer_type)
    • 연결 해제 안내 문구의 언어(locale): 한국어(KO)
curl -v -G "http://kapi.kakao.com/v2/internal/account/app/unlinkable" \
-H "Authorization: KakaoAK ${DELEGATOR_APP_ADMIN_KEY}" \
-d "target_app_id=1159109" \
-d "account_id=2350171" \
-d "referrer_type=UNLINK_FROM_APPS" \
-d "locale=KO"
  • APP_NAME: 연결 해제 대상 앱 이름
// HTTP/1.1 200 OK
{
"user_id": 1376016924430764417,
"can_unlink": true,
"title": "카카오계정과 ${APP_NAME}의 연결 해제",
"message": "카카오는 ${APP_NAME}에게 더이상 데이터를 제공하지 않으며 데이터 제공에 대한 동의를 철회합니다. ${APP_NAME}에 로그인 되어있는 카카오계정은 모두 로그아웃 됩니다. 또한 ${APP_NAME}에게 서비스 탈퇴에 따른 개인정보 삭제를 요청합니다. 최종 서비스 탈퇴 및 개인정보 삭제는 해당 서비스에서 확인하시기 바랍니다.",
"button_label": "연결 해제",
"unlink_token": "MTkxNjg3NDEzNzYwMTY5MjQ0MzAyNDcxODYwMzEzMjAyOTExNzEzNzQwNw=="
}
  • APP_NAME: 연결 해제 대상 앱 이름
// HTTP/1.1 200 OK
{
"user_id": 1376016924430764417,
"can_unlink": true,
"title": "카카오계정과 ${APP_NAME}의 연결 해제",
"message": "카카오는 ${APP_NAME}에게 더이상 데이터를 제공하지 않으며 데이터 제공에 대한 동의를 철회합니다. ${APP_NAME}에 로그인 되어있는 카카오계정은 모두 로그아웃 됩니다. ${APP_NAME}에서 보관중인 개인정보 및 이용기록 삭제를 원하시는 경우, ${APP_NAME}에서 직접 탈퇴하시기 바랍니다.",
"button_label": "연결 해제",
"unlink_token": "MTkxNjg3NDEzNzYwMTY5MjQ0MzAyNDcxODYwMzEzMjAyOTExNzEzNzQwNw=="
}
  • APP_NAME: 연결 해제 대상 앱 이름
// HTTP/1.1 200 OK
{
"user_id": 1376016924430764417,
"can_unlink": false,
"title": "연결 해제 할 수 없습니다.",
"message": "이 서비스는 직접 서비스로 이동해 연결 해제해야 합니다.",
"button_label": "닫기"
}
메서드URL인증 방식
POST카카오
http://kapi.kakao.com/v1/internal/account/unlink
공동체
https://kapi.kakao.com/v1/internal/account/unlink
위임

카카오계정을 특정 연결된 앱에서 연결 해제 처리합니다. 이 API는 대상 앱과 연결된 카카오계정 대상으로만 요청 가능합니다.

헤더에 카카오계정 시스템 앱의 어드민 키를 담아 POST로 요청합니다. 요청 시 연결 해제 대상인 서비스 앱 ID와 카카오계정 ID를 전달해야 합니다. 또한 연결 해제 요청이 발생한 경로를 referrer_type에 명시해야 합니다. unlink_token 파라미터의 값은 연결 해제 가능 여부 조회 응답에서 구할 수 있습니다.

요청 성공 시 응답은 카카오계정 ID, 연결 해제 처리된 앱과 회원번호를 포함합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${DELEGATOR_APP_ADMIN_KEY}
인증 방식, 플랫폼 앱 어드민 키로 인증 요청
서비스 앱의 권한을 플랫폼 앱이 위임받아 요청하는 방식으로 내부 API 요청 시 사용 가능
서비스 구분을 위해 서비스 앱의 앱 ID, 앱 키, 토큰 중 하나 파라미터로 전달 필요
O
이름타입설명필수
account_idInteger카카오계정 IDO
target_app_idString서비스 앱의 IDO
referrer_typeString연결 해제 요청이 발생한 경로, 아래 중 하나
  • UNLINK_FROM_ADMIN: CS로 인한 연결 해제 처리
  • UNLINK_FROM_APPS: 연결된 서비스 관리

참고: 연결 해제 웹훅
O
localeString응답 언어 지정, 아래 중 하나
  • KO: 한국어
  • EN: 영어
  • JA: 일본어
(기본값: KO)
X
do_unlink_onlyBoolean요청 시 연결 해제만 수행할 것인지 여부
  • true: 연결 해제만 수행
  • false: 서비스 데이터 삭제도 함께 요청, 아래 unlink_token 파라미터를 사용해야 함

중요: do_unlink_only 또는 unlink_token 중 하나 필수
O(Optional)
unlink_tokenStringreferrer_type 값이 UNLINK_FROM_APPS인 경우, 연결 해제와 함께 서비스 데이터 삭제를 요청하기 위해 필요
동일 카카오계정 및 앱에 대한 연결 해제 가능 여부 조회 호출 응답으로 획득

중요: do_unlink_only 파라미터 값이 false이거나, 해당 파라미터 미사용 시 필수
O(Optional)
이름타입설명필수
account_idInteger카카오계정 IDO
userUserDefaultInfoWithAppDefaultInfo카카오계정과 연결 해제된 앱 정보O
이름타입설명필수
idLong회원번호O
appAppDefaultInfo앱 정보O
이름타입설명필수
idInteger앱 IDO
  • 파라미터
    • 서비스 앱 키(target_app_key)
    • 카카오계정 ID(account_id)
curl -v -X POST "http://kapi.kakao.com/v1/internal/account/unlink" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "target_app_id=1159109" \
-d "account_id=2137162" \
-d "referrer_type=UNLINK_FROM_APPS" \
-d "do_unlink_only=true"
// HTTP/1.1 200 OK
{
"account_id": 2137162,
"user": {
"id": 1376016924430613923,
"app": {
"id": 1159109
}
}
}
메서드URL인증 방식
POST카카오
http://kapi.kakao.com/v1/internal/account/unlinkall
공동체
https://kapi.kakao.com/v1/internal/account/unlinkall
서비스 앱 어드민 키

카카오계정을 모든 연결된 앱에서 연결 해제 처리합니다. 이 API는 카카오계정 탈퇴로 모든 연결된 앱에서 탈퇴 처리해야 할 때 사용하며, 카카오계정이 연결 또는 연결 대기 상태인 앱 대상으로만 동작합니다.

헤더에 카카오계정 시스템 앱의 어드민 키를 담아 POST로 요청합니다. 요청 시 대상 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오계정 ID, 연결 해제 처리된 앱과 회원번호 목록을 포함합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
이름타입설명필수
account_idInteger카카오계정 IDO
usersUsers카카오계정과 연결 해제된 앱 정보O
이름타입설명필수
total_countInteger카카오계정과 연결 해제된 앱 수O
elementsUserDefaultInfoWithAppDefaultInfo[]카카오계정과 연결 해제된 앱 정보O
  • 파라미터
    • 카카오계정 ID(account_id)
curl -v -X POST "http://kapi.kakao.com/v1/internal/account/unlinkall" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2350171"
// HTTP/1.1 200 OK
{
"account_id": 2350171,
"users": {
"total_count": 4,
"elements": [
{
"id": 1376016924429838028,
"app": {
"id": 1089144
}
},
{
"id": 1376016924430764416,
"app": {
"id": 57669
}
},
{
"id": 1376016924430764419,
"app": {
"id": 1159109
}
},
{
"id": 1376016924430764417,
"app": {
"id": 977071
}
}
]
}
}
메서드URL인증 방식
POST카카오
http://kapi.kakao.com/v1/internal/account/revoke/service_terms
공동체
https://kapi.kakao.com/v1/internal/account/revoke/service_terms
서비스 앱 어드민 키

통합 서비스 약관 동의를 철회한 경우, 카카오계정을 연결된 모든 인하우스 앱에서 연결 해제 처리합니다. 통합 서비스 약관에 사용자가 동의 철회한 경우, 해당 사용자의 카카오계정으로 사용 중인 모든 인하우스 앱 서비스에서 연결 해제(탈퇴) 처리하기 위해 사용합니다. 단, 인하우스 앱이지만 동의 화면을 출력하는 서비스나 비즈향 서비스 등 약관 관련 특이 사항이 있는 서비스의 앱은 연결 해제 처리 시 제외됩니다.

헤더에 카카오계정 시스템 앱의 어드민 키를 담아 POST로 요청합니다. 요청 시 대상 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오계정 ID, 연결 해제 처리된 앱과 회원번호 목록을 포함합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
이름타입설명필수
account_idInteger카카오계정 IDO
usersUsers카카오계정과 연결 해제된 앱 정보O
  • 파라미터
    • 카카오계정 ID(account_id)
curl -v -X POST "http://kapi.kakao.com/v1/internal/account/revoke/service_terms" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2350171"
// HTTP/1.1 200 OK
{
"account_id": 2350171,
"users": {
"total_count": 1,
"elements": [
{
"id": 1376016924430764417,
"app": {
"id": 977071
}
}
// ...
]
}
}
메서드URL인증 방식
POST카카오
http://kapi.kakao.com/v1/internal/account/ageauth/reset
공동체
https://kapi.kakao.com/v1/internal/account/ageauth/reset
서비스 앱 어드민 키

카카오계정의 연령인증 정보 초기화 시, 카카오 API 플랫폼에서 다시 연령인증 정보를 확인하도록 사용자 상태를 변경합니다. 연령인증 정보 초기화로 인해 사용자의 상태가 변경될 경우, 해당 카카오계정의 카카오 로그인 또는 카카오 API 요청 시 연령인증을 다시 수행합니다.

헤더에 카카오계정 시스템 앱의 어드민 키를 담아 POST로 요청합니다. 요청 시 대상 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오계정과 연결된 앱 중 영향받은 앱 수를 포함합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
이름타입설명필수
affected_usersInteger영향받은 카카오계정 수O
  • 파라미터
    • 카카오계정 ID(account_id)
curl -v -X POST "http://kapi.kakao.com/v1/internal/account/ageauth/reset" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2350171"
// HTTP/1.1 200 OK
{
"affected_users": 1
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v1/internal/account/deletable
공동체
https://kapi.kakao.com/v1/internal/account/deletable
서비스 앱 어드민 키

카카오계정 탈퇴 시, 카카오디벨로퍼스 탈퇴 가능 여부를 확인합니다. 이 API를 사용해 탈퇴 가능 여부 및 탈퇴 불가 원인을 확인할 수 있습니다. 카카오계정이 소유한 앱이 있는 개발자 계정이거나, 연결 해제 불가 사유 API 호출 시 연결을 끊을 수 없는 앱이 있는지 알 수 있습니다. 단, 카카오계정이 카카오비즈니스 통합 계정인 경우, 앱을 소유한 개발자 계정이라도 연결 해제 가능 여부를 true로 반환합니다.(참고: 카카오비즈니스: 탈퇴 가능 여부 조회)

헤더에 카카오계정 시스템 앱의 어드민 키를 담아 GET으로 요청합니다. 요청 시 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오디벨로퍼스 탈퇴 가능 여부, 탈퇴 불가 사유 문구를 포함합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
localeString탈퇴 불가 사유 문구의 언어 지정, 아래 중 하나
  • KO: 한국어
  • EN: 영어
  • JA: 일본어
  • zh-CN: 중국어(간체)
  • zh-TW: 중국어(번체)
(기본값: EN)
X
이름타입설명필수
deactivationDeactivation탈퇴 가능 여부 정보O
이름타입설명필수
canDeactivateBoolean카카오디벨로퍼스 탈퇴 가능 여부
  • true: 가능
  • false: 불가
O
titleString탈퇴 불가 사유 문구 제목, 기본 문자열로 구성

중요: canDeactivate 값이 false인 경우에만 응답에 포함
X
messageString탈퇴 불가 사유 문구 본문

중요: canDeactivate 값이 false인 경우에만 응답에 포함
X
labelStringlink의 버튼에 사용할 수 있는 문구

중요: canDeactivate 값이 false인 경우에만 응답에 포함
X
linkString탈퇴 불가 사유 해소를 위한 서비스 페이지 바로가기 URL

중요: canDeactivate 값이 false인 경우에만 응답에 포함
X
  • 파라미터
    • 카카오계정 ID(account_id)
    • 탈퇴 불가 사유 문구 언어(target_id_type): 한국어(KO)
curl -v -G GET "http://kapi.kakao.com/v1/internal/account/deletable" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2350171" \
-d "locale=KO"
// HTTP/1.1 200 OK
{
"deactivation": {
"canDeactivate": true
}
}
// HTTP/1.1 200 OK
{
"deactivation": {
"canDeactivate": false,
"title": "앱을 소유하고 있는 개발자 계정입니다.",
"label": "탈퇴하기",
"message": "카카오 개발자 웹사이트에서 소유한 앱의 OWNER 권한을 다른 사용자에게 양도하거나 앱 삭제 후 카카오계정을 탈퇴해 주세요.",
"link": "https://developers.kakao.com/user/profile"
}
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v1/internal/account/search
공동체
https://kapi.kakao.com/v1/internal/account/search
서비스 앱 어드민 키

이메일에 해당하는 카카오계정 ID를 조회합니다.

해당 API는 다른 사용자 카카오계정 검색와 달리 대상과 앱의 연결 관계에 상관 없이 ID를 조회할 수 있어, 보안 유지를 위한 호출 허용 IP 주소 등록필수 사항입니다. 앱 관리 페이지의 [앱] > [어드민 키] > [호출 허용 IP 주소] 에서 API를 호출하는 서버의 IP를 등록해야 합니다. 자세한 내용은 보안: 호출 허용 IP 주소를 참고합니다.

서비스 앱 어드민 키를 헤더에 담아 GET으로 요청합니다. email에 카카오계정 ID를 조회할 이메일과 results에 조회 대상 ID 유형을 파라미터로 전달해야 합니다. 조회 대상 ID 유형은 results=account_id,talk_id와 같이 여러 유형으로 요청할 수 있습니다.

요청 성공 시 응답은 results 파라미터로 지정한 유형별 ID 값입니다. 각 ID 값은 제공 조건을 만족해야만 응답에 포함됩니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
emailString카카오계정 ID를 조회할 이메일 주소O
resultsString조회할 ID 종류, 아래 중 하나 이상의 값 사용 가능, 여러 개 사용 시 쉼표(,)로 구분
  • account_id: 카카오계정 ID
  • talk_id: 카카오톡 회원번호
(예: account_id,talk_id)
O
이름타입설명필수
account_idInteger카카오계정 ID

제공 조건: 카카오계정 ID 응답 권한이 있는 경우
X
talk_idLong카카오톡 회원번호

제공 조건: 해당 사용자가 카카오톡 사용자이고 카카오톡 회원번호 응답 권한이 있는 경우
X
  • 파라미터
    • 카카오계정 ID를 조회할 이메일 주소(email)
    • 조회할 ID 유형: 카카오계정 ID(account_id), 카카오톡 회원번호(talk_id)
curl -v -G GET "http://kapi.kakao.com/v1/internal/account/search" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "email=test@test.kakao.com" \
-d "results=account_id,talk_id"
// HTTP/1.1 200 OK
{
"account_id": 2137162, // 카카오계정ID 응답 권한 필요
"talk_id": 700119942 // 카카오톡 회원번호 응답 권한 필요
}
// HTTP/1.1 400
{
"msg": "the kakao account which associated with this email does not exist.",
"code": -103
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v1/internal/user/account/search
공동체
https://kapi.kakao.com/v1/internal/user/account/search
액세스 토큰
서비스 앱 어드민 키

카카오계정 정보를 서비스에 로그인한 사용자 인증으로 조회합니다. 서비스 가입자가 제공 정보에 해당하는 사용자의 상태를 확인 후 서비스 가입을 유도하기 위한 용도로 사용 가능합니다.

원하는 인증 정보를 헤더에 담아 GET으로 요청합니다. 조회할 카카오계정 관련 정보와 조회 대상 유형을 파라미터로 전달해야 합니다. 조회 대상 유형은 results=account_id,user_id,talk_id,uuid,email와 같이 여러 유형으로 요청할 수 있습니다.

요청 성공 시 응답은 results 파라미터로 지정한 유형 값이며, 제공 조건을 만족해야 응답에 포함됩니다.

이름설명필수
AuthorizationAuthorization: Bearer ${ACCESS_TOKEN}
인증 방식, 액세스 토큰으로 인증 요청
O
이름타입설명필수
emailString카카오계정 정보를 조회할 이메일 주소X
invitee_idString카카오계정 정보를 조회할 ID

중요: email 미포함 시 필수
X
invitee_id_typeString카카오계정 정보를 조회할 ID 종류, 아래 중 하나 이상의 값 사용 가능, 여러 개 사용 시 쉼표(,)로 구분
  • user_id: 회원번호
  • account_id: 카카오계정 ID
  • talk_id: 카카오톡 회원번호
  • uuid: 고유 ID

중요: email 미포함 시 필수
X
resultsString조회할 카카오계정 정보(참고: ID 종류), 아래 중 하나 이상의 값 사용 가능, 여러 개 사용 시 쉼표(,)로 구분
  • user_id: 회원번호
  • account_id: 카카오계정 ID
  • talk_id: 카카오톡 회원번호
  • uuid: 고유 ID
  • email: 이메일 주소
(예: user_id,account_id,talk_id,uuid,email)
O
이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
Content-TypeContent-Type: application/x-www-form-urlencoded;charset=utf-8
요청 데이터 타입
O
이름타입설명필수
target_idString사용자 IDO
target_id_typeStringtarget_id 타입, 아래 중 하나
  • user_id: 회원번호
  • account_id: 카카오계정 ID
  • talk_id: 카카오톡 회원번호
O
emailString카카오계정 ID를 조회할 이메일 주소O
invitee_idString카카오계정 정보를 조회할 ID

중요: email 미포함 시 필수
X
invitee_id_typeString카카오계정 정보를 조회할 ID 종류, 아래 중 하나 이상의 값 사용 가능, 여러 개 사용 시 쉼표(,)로 구분
  • user_id: 회원번호
  • account_id: 카카오계정 ID
  • talk_id: 카카오톡 회원번호
  • uuid: 고유 ID

중요: email 미포함 시 필수
X
resultsString조회할 카카오계정 정보(참고: ID 종류), 아래 중 하나 이상의 값 사용 가능, 여러 개 사용 시 쉼표(,)로 구분
  • user_id: 회원번호
  • account_id: 카카오계정 ID
  • talk_id: 카카오톡 회원번호
  • uuid: 고유 ID
  • email: 이메일 주소
(예: user_id,account_id,talk_id,uuid,email)
O
이름타입설명필수
user_idLong회원번호

제공 조건: 해당 사용자의 회원번호가 존재하는 경우
X
account_idInteger카카오계정 ID

제공 조건: 카카오계정 ID 응답 권한이 있는 경우
X
talk_idLong카카오톡 회원번호

제공 조건: 해당 사용자가 카카오톡 사용자이고 카카오톡 회원번호 응답 권한이 있는 경우
X
uuidString사용자 고유 IDX
emailString이메일 주소X
  • 파라미터
    • 카카오계정 정보를 조회할 이메일 주소(email)
    • 조회할 정보 유형: 회원번호(user_id), 카카오계정 ID(account_id), 카카오톡 회원번호(talk_id), 고유 ID(uuid)
curl -v -G GET "http://kapi.kakao.com/v1/internal/user/account/search" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-d "email=test@test.kakao.com" \
-d "results=account_id,user_id,talk_id,uuid"
  • 파라미터
    • 사용자 ID(target_id)
    • 사용자 ID 타입(target_id_type): 회원번호(user_id)
    • 카카오계정 정보를 조회할 ID(invitee_id)
    • 카카오계정 정보를 조회할 ID 유형(invitee_id_type): 고유 ID(uuid)
    • 조회할 정보 유형: 회원번호(user_id), 카카오계정 ID(account_id), 카카오톡 회원번호(talk_id), 고유 ID(uuid), 이메일(email)
curl -v -G GET "http://kapi.kakao.com/v1/internal/user/account/search" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "target_id=12345" \
-d "target_id_type=user_id" \
-d "invitee_id=${INVITEE_ID}" \
-d "invitee_id_type=uuid" \
-d "results=account_id,user_id,talk_id,uuid,email"
// HTTP/1.1 200 OK
{
"user_id": 1376016924429759243, // 해당 사용자의 회원번호가 존재하는 경우
"account_id": 2137162, // 카카오계정ID 응답 권한 필요
"talk_id": 700119942, // 카카오톡 회원번호 응답 권한 필요
"uuid": "YlBhUmVUYlB8S3tLektyS39NYVhvWGhfbg0",
"email": "test2@test.kakao.com"
}
// HTTP/1.1 400
{
"msg": "the kakao account which associated with this email does not exist.",
"code": -103
}

도움이 되었나요?