데이터 SDK

동의 기반 사용자 데이터 조회하기

post

미니앱에 등록된 동의 기반 사용자 데이터 항목의 사용자 동의 상태를 확인해요. 사용자가 최신 동의 내용에 동의했다면 실제 데이터 값을 반환하고, 아직 동의하지 않았거나 동의를 거부한 경우에는 데이터 대신 동의 화면으로 이동할 수 있는 URL을 반환해요.

비즈니스 오류 코드

아래 오류는 HTTP 200과 resultType: FAIL로 응답해요.

errorCode	설명
4010	인증 정보를 찾을 수 없어요.

Authorizations

mutualTLS

파트너에게 발급된 클라이언트 인증서 기반 mTLS 인증이에요. 인증서의 CN으로 미니앱을 식별해요. 인증서 발급·관리 방법은 서버 API 이용하기 문서를 참고하세요.

Header parameters

x-toss-user-keystringRequired

사용자를 인증하기 위한 키예요. 사용자 정보 받기 API를 통해 획득할 수 있어요

Example: 12345678

Body

동의 기반 사용자 데이터 조회 요청 본문이에요.

consentedUserDataKeystringRequired

조회할 동의 기반 사용자 데이터 항목을 식별하는 키예요. 파트너 워크스페이스 콘솔에서 동의 기반 사용자 데이터 항목을 등록하면 발급돼요.

Example: cud_1234567890abcdef1234567890abcdef

Responses

200

요청 처리 결과예요. resultType 값으로 성공/실패를 구분하세요.

application/json

or

400

요청 본문이 형식에 맞지 않아요. error.data.errorDetails에서 필드별 상세를 확인하세요.

application/json

500

분류되지 않은 서버 오류예요. 계속 실패하면 파트너 지원 채널로 문의해 주세요.

application/json

post/api-partner/v1/apps-in-toss/data-sdk/get-consented-user-data

POST /api-partner/v1/apps-in-toss/data-sdk/get-consented-user-data HTTP/1.1
Host: apps-in-toss-api.toss.im
x-toss-user-key: {userKey}
Content-Type: application/json

{
  "consentedUserDataKey": "cud_1234567890abcdef1234567890abcdef"
}

{
  "resultType": "SUCCESS",
  "success": {
    "type": "PROVIDED",
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}