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

kakao developers

관련사이트

사이드 메뉴

플랫폼 API

API 제공

전용 API

어드민 API

이 문서는 일부 REST API의 기존 버전 사용 방법을 안내합니다. 이 문서는 예고 없이 변경 또는 삭제될 수 있으므로, 가급적 최신 버전 사용을 권장합니다.

요청 시 전달된 본인인증 정보가 카카오계정의 본인인증 정보와 일치하는지 비교합니다. 이 API는 공동체 전용으로 카카오계정파트와 협의 후 권한을 받아야 사용할 수 있습니다.

헤더에 원하는 인증 방식별 정보를 담아 GET으로 요청합니다. 요청 시 전달된 사용자의 CI(연계정보)와 생년월일이 카카오계정의 본인인증 정보와 일치할 경우 성공 응답을 받습니다. 카카오계정에 본인인증 정보가 없는 경우에도 성공 응답이 반환됩니다. 요청 성공 시 응답은 회원번호(user_id)와 연결 상태(user_status)를 포함합니다. 응답 중 카카오계정 ID(account_id)권한이 있는 앱에서 요청한 경우에만 응답에 포함됩니다.

사용자가 앱과 연결되지 않은 경우, CI와 생년월일이 카카오계정의 본인인증 정보와 일치하지 않을 경우에는 에러 응답을 반환합니다. 인증 레벨이 서로 다른 경우에도 요청이 실패할 수 있으며, 카카오계정의 정책에 따릅니다.(예: 공동체의 인증 레벨이 1차(실명인증), 카카오계정의 인증 레벨이 2차(본인인증)로 카카오계정의 인증 레벨이 더 높은 경우)

메서드호스트Internal URLExternal URL
GETkapi.kakao.com/v1/internal/user/verify/auth_info-
이름형식설명
액세스 토큰 방식Authorization: Bearer ${ACCESS_TOKEN}서비스 앱에서 액세스 토큰으로 요청합니다.
서비스 앱 어드민 키 방식Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}서비스 앱에서 어드민 키와 사용자 ID로 요청합니다.
이름타입설명필수
ciString공동체에서 자체 본인인증으로 획득한 사용자의 CIO
birth_dateString사용자의 생년월일, YYYYMMDD 형식O
이름타입설명필수
target_idString사용자 IDO
target_id_typeStringtarget_id 타입
user_id: 회원번호
account_id: 카카오계정 ID
talk_id: 카카오톡 회원번호
O
ciString공동체에서 자체 본인인증으로 획득한 사용자의 CIO
birth_dateString사용자의 생년월일, YYYYMMDD 형식O
이름타입설명필수
idLong회원번호O
account_idLong카카오계정 ID

제공 조건: 카카오계정 ID 응답 권한 보유
X
user_statusString사용자의 앱 연결 상태, 아래 중 하나
  • REGISTERED: 연결
  • PREREGISTERED: 연결 대기
O
  • 파라미터
    • CI(ci)
    • 생년월일(birth_date)
curl -v -G GET "http://kapi.kakao.com/v1/internal/user/verify/auth_info" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
--data-urlencode "ci=${CI}" \
--data-urlencode "birth_date=20000101"
  • 파라미터
    • 사용자 ID(target_id)
    • 사용자 ID 타입(target_id_type): 회원번호(user_id)
    • CI(ci)
    • 생년월일(birth_date)
curl -v -G GET "http://kapi.kakao.com/v1/internal/user/verify/auth_info" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "target_id=123465" \
-d "target_id_type=user_id" \
--data-urlencode "ci=${CI}" \
--data-urlencode "birth_date=20000101"
{
"id": 123465,
"account_id": 12345, // 카카오계정 ID 응답 권한 필요
"user_status": "PREREGISTERED"
}
// HTTP/1.1 400 Bad Request
{
"code": -2,
"msg": "failed to verify auth info. Kakao have stored different authentication information."
}

사용자 카카오계정에 공동체에서 수집한 본인인증 정보를 수집(저장)합니다. 이 API는 공동체 전용으로 카카오계정파트와 협의 후 권한을 받아야 사용할 수 있습니다.

헤더에 원하는 인증 방식별 정보를 담아 POST로 요청합니다. 요청 시 카카오계정에 수집할 CI(연계정보)와 생년월일, 인증기관 및 타입을 전달해야 합니다. 사용자가 카카오 로그인수동 연결로 앱과 연결 완료된 상태(REGISTERED)일 때만 호출할 수 있습니다.

요청 성공 시 응답은 회원번호(user_id)와 연결 상태(user_status)를 포함합니다. 응답 중 카카오계정 ID(account_id)권한이 있는 앱에서 요청한 경우에만 응답에 포함됩니다.

사용자가 앱과 연결되지 않은 경우, CI와 생년월일이 카카오계정의 본인인증 정보와 일치하지 않을 경우에는 에러 응답을 반환합니다. 인증 레벨이 서로 다른 경우에도 요청이 실패할 수 있으며, 카카오계정의 정책에 따릅니다.(예: 공동체의 인증 레벨이 1차(실명인증), 카카오계정의 인증 레벨이 2차(본인인증)로 카카오계정의 인증 레벨이 더 높은 경우)

제3자 제공동의

공동체에서 수집한 본인인증 정보를 카카오계정에 저장하려면 해당 정보를 공동체 서비스에서 카카오로 제공한다는 제3자 제공동의를 받아야 합니다.

메서드호스트Internal URLExternal URL
POSTkapi.kakao.com/v1/internal/user/collect/auth_info-
이름형식설명
액세스 토큰 방식Authorization: Bearer ${ACCESS_TOKEN}서비스 앱에서 액세스 토큰으로 요청합니다.
서비스 앱 어드민 키 방식Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}서비스 앱에서 어드민 키와 사용자 ID로 요청합니다.
이름타입설명필수
ciString공동체에서 자체 본인인증으로 획득한 사용자의 CIO
birth_dateString사용자의 생년월일, YYYYMMDD 형식O
auth_typeString본인인증기관 및 본인인증방식, 아래 중 하나
  • DANAL_PHONE
  • DANAL_SMS
  • DREAMSECURITY_SMS
  • KCB_CREDIT
  • KMC_SMS
  • NICE_NAME
  • SCI_SMS
O
이름타입설명필수
target_idString사용자 IDO
target_id_typeStringtarget_id 타입
user_id: 회원번호
account_id: 카카오계정 ID
talk_id: 카카오톡 회원번호
O
ciString공동체에서 자체 본인인증으로 획득한 사용자의 CIO
birth_dateString사용자의 생년월일, YYYYMMDD 형식O
auth_typeString본인인증기관 및 본인인증방식, 아래 중 하나
  • DANAL_PHONE
  • DANAL_SMS
  • DREAMSECURITY_SMS
  • KCB_CREDIT
  • KMC_SMS
  • NICE_NAME
  • SCI_SMS
O
이름타입설명필수
idLong회원번호O
account_idLong카카오계정 ID

제공 조건: 카카오계정 ID 응답 권한 보유
X
user_statusString사용자의 앱 연결 상태
REGISTERED(연결)만 존재
O
  • 파라미터
    • CI(ci)
    • 생년월일(birth_date)
    • 인증기관 및 타입(auth_type)
curl -v -X POST "http://kapi.kakao.com/v1/internal/user/collect/auth_info" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
--data-urlencode "ci=${CI}" \
--data-urlencode "birth_date=20000101" \
--data-urlencode "auth_type=DREAMSECURITY_SMS"
  • 파라미터
    • 사용자 ID(target_id)
    • 사용자 ID 타입(target_id_type): 회원번호(user_id)
    • CI(ci)
    • 생년월일(birth_date)
    • 인증기관 및 타입(auth_type)
curl -v -X POST "http://kapi.kakao.com/v1/internal/user/collect/auth_info" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "target_id=123465" \
-d "target_id_type=user_id" \
--data-urlencode "ci=${CI}" \
--data-urlencode "birth_date=20000101" \
--data-urlencode "auth_type=DREAMSECURITY_SMS"
{
"id": 123465,
"account_id": 12345,
"user_status": "REGISTERED"
}
// HTTP/1.1 400 Bad Request
{
"code": -2,
"msg": "failed to set auth info. Kakao have stored different authentication information."
}

사용자 카카오계정에 수집한 공동체의 본인인증 정보를 삭제합니다. 공동체 서비스에서 수집한 본인인증 정보를 카카오에 저장한 경우, 서비스에서 해당 정보를 삭제할 때 카카오에도 삭제 요청을 해야 합니다. 이 API는 공동체 전용으로 카카오계정파트와 협의 후 권한을 받아야 사용할 수 있습니다.

헤더에 원하는 인증 방식별 정보를 담아 DELETE로 요청합니다. 이 API는 사용자가 카카오 로그인수동 연결로 앱과 연결 완료된 상태(REGISTERED)일 때만 호출할 수 있습니다. 요청 성공 시 HTTP 상태 코드 200을 반환하며 응답 바디는 없습니다.

메서드호스트Internal URLExternal URL
DELETEkapi.kakao.com/v1/internal/user/delete/auth_info-
이름형식설명
액세스 토큰 방식Authorization: Bearer ${ACCESS_TOKEN}서비스 앱에서 액세스 토큰으로 요청합니다.
서비스 앱 어드민 키 방식Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}서비스 앱에서 어드민 키와 사용자 ID로 요청합니다.
이름타입설명필수
target_idString사용자 IDO
target_id_typeStringtarget_id 타입
user_id: 회원번호
account_id: 카카오계정 ID
talk_id: 카카오톡 회원번호
O
  • 파라미터: 없음
curl -v -X DELETE "http://kapi.kakao.com/v1/internal/user/delete/auth_info" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"
  • 파라미터
    • 사용자 ID(target_id)
    • 사용자 ID 타입(target_id_type): 회원번호(user_id)
curl -v -G -X DELETE "http://kapi.kakao.com/v1/internal/user/delete/auth_info" \
-H "Authorization: Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "target_id=123456" \
-d "target_id_type=user_id"

도움이 되었나요?