Konaplate logo

API 문서

전체 API

서비스


약관 목록 조회동기

버전: v1


버전: v1

POST

/api/v1/user/terms/all

약관 목록을 조회합니다. - `X-KM-AspId` 정보만 있는 요청인 경우 : 해당 ASP_ID 의 속한 모든 약관 목록을 조회 합니다. - `userId` 정보 포함된 요청인 경우 : 해당 ASP ID의 속한 모든 약관 목록을 조회하고, 약관 별 해당 회원의 약관 동의 여부가 포함됩니다.

요청 헤더


X-KM-User-AspId

string

필수

길이 : 15

ASP ID

  • 서비스 사업자에게 부여한 ID입니다.
  • ID는 계약 시 제공됩니다.

X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

  • 형식 : yyMMddHHmiSS-xxxxxxx
  • xxxxxxx : 7자리, Hex String

X-KM-Access-Key

string

조건부

길이 : 40

프로젝트에서 생성된 Access Key

  • Callback API 인 경우는 제외합니다.

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

  • 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
  • 데이터 암호화 요청 시 필수 입력값입니다. (Data Encryption = Y)

X-KM-Tran-Token

string

필수

길이 : 66

공통 Header 정보 - X-KM-Tran-Token

X-KM-Tran-Time

string

필수

길이 : 14

클라이언트 요청 시간

  • 형식 : YYYYMMDDHHMMSS

X-KM-Time-Zone

string

필수

길이 : 3

시간대 정보 (UTC, KST, ...)

요청 파라미터


userId

number

옵션

최소 : 1 , 최대 : 9999999999999999999

회원 ID

locale

string

옵션

최소 : 2 , 최대 : 3

국가 언어

-기본값 : KO

tcActionType

string

옵션

최소 : 1 , 최대 : 255

약관 용도 타입

아래는 약관의 용도 타입 목록 입니다.

-PY : 개인 정보 수집
-UNDER_14 : 만 14세 미만
-COUPON_SHOP : 쿠폰샵
-EZWEL : 복지몰
-OPEN_BANK : 오픈뱅킹
-OPEN_BANK_SPECIFIC : 오픈뱅킹 출금/조회
-MKT_NOTI : 마케팅 수신
-DEDUCT : 자동소득공제

viewPositionType

string

옵션

최소 : 1 , 최대 : 20

약관 노출 시점 구분 타입

-OPEN_BANK : 오픈 뱅킹 서비스 이용 시점
-USER_PORTAL_CARD : 카드관리사이트 이용 시점
-NULL : 회원 가입 시점

응답 헤더


X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

  • 형식 : yyMMddHHmiSS-xxxxxxx
  • xxxxxxx : 7자리, Hex String

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

  • 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
  • Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.

응답 파라미터


termsList

array of objects

필수

약관 목록

termsList_item

object

옵션

termsList_item content

tcId

number

필수

최소 : 1 , 최대 : 9999999999999999999

약관 ID

tcActionType

string

옵션

최소 : 1 , 최대 : 255

약관 용도 타입

- PY : 개인 정보 수집
- UNDER_14 : 만 14세 미만
- COUPON_SHOP : 쿠폰샵
- EZWEL : 복지몰
- OPEN_BANK : 오픈뱅킹
- OPEN_BANK_SPECIFIC : 오픈뱅킹 출금/조회
- MKT_NOTI : 마케팅 수신
- DEDUCT : 자동소득공제

title

string

필수

최소 : 1 , 최대 : 255

약관 명

url

string

필수

최소 : 1 , 최대 : 255

약관 URL

required

string

필수

최소 : 1 , 최대 : 255

약관 필수 구분

- MANDATORY : 필수
- OPTIONAL : 필수 아님

order

string

필수

최소 : 1 , 최대 : 8

약관 순서

isAgree

boolean

필수

회원 동의 여부

요청 "userId"가 있는 경우 :
- 회원이 동의한 약관의 경우 true, 동의하지 않은 약관의 경우 false

요청 "userId"가 없는 경우 :
- false

agreeDate

string

옵션

길이 : 17

회원 약관 동의 일자

- 형식 : yyyyMMddHHmmssSSS
- 요청 "userId"가 있는 경우에 사용됩니다.

viewPositionType

string

옵션

최소 : 1 , 최대 : 20

약관 노출 시점

- OPEN_BANKING : 오픈 뱅킹 시점
- USER_PORTAL_CARD : 카드관리사이트 이용 시점
- NULL : 회원 가입 시점

응답 코드

Detailed classification and addition of error for unseccessful withfrawal


200

에러 코드

000_000

메시지

Success.

설명

성공

테스트 데이터

200 - 성공 테스트 - `userId` 만 요청하여 소속 ASP 약관 목록 조회


200 - 성공 테스트 - `userId` 만 요청하여 소속 ASP 약관 목록 조회
Loading ...

Request

Loading...

Response

Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.


회원 가입회원 정보 조회회원 비밀번호 재설정 및 변경회원 정보 변경회원 탈퇴회원 로그인 ID 확인휴면 회원 해제약관 목록 조회약관 동의 및 철회CI 값으로 회원 정보 조회회원 로그인 ID 중복 확인회원 비밀번호 검증회원 인증 정보 조회금융사 목록 조회계좌 예금주 실명 검증ARS 인증 전 인증코드 생성PG를 통한 은행 계좌 등록계좌 등록 상태 조회기명화 및 한도상향(개인)회원 등록 계좌 조회회원 계좌 정보 조회자동충전 계좌 등록회원 계좌 삭제일회용 토큰 발급계좌 충전계좌 충전취소충전 및 충전취소 결과 확인거래내역 확인선불카드 발급 및 배송 신청카드 신청 취소선불카드 재발급(교체발급)만료 예정 선불카드 재발급 갱신카드 배송 상태 조회실물카드와 연결 가능한 모바일카드 신청 정보 조회실물카드 등록보유카드 조회미등록 카드 조회카드 상태 변경카드 폐기기명화 및 한도상향(개인)기명화 및 한도상향(법인)법인 기명화 여부 조회소득공제 신청카드 소득공제 신청 여부 조회카드 매핑 회원 조회카드 상품ID로 상품 정보 조회주카드 설정카드에 연결된 가상계좌 조회회원 가입회원 정보 조회회원 비밀번호 재설정 및 변경회원 정보 변경회원 탈퇴회원 로그인 ID 확인휴면 회원 해제약관 목록 조회약관 동의 및 철회CI 값으로 회원 정보 조회회원 로그인 ID 중복 확인회원 비밀번호 검증회원 인증 정보 조회금융사 목록 조회계좌 예금주 실명 검증ARS 인증 전 인증코드 생성PG를 통한 은행 계좌 등록계좌 등록 상태 조회기명화 및 한도상향(개인)회원 등록 계좌 조회회원 계좌 정보 조회자동충전 계좌 등록회원 계좌 삭제