개발자센터

본인인증 관련 API

본인인증과 관련된 API 기능을 제공합니다.

요청된 본인인증에 대한 확인을 진행합니다.

SMS 본인인증 요청을 재전송합니다.

SMS 또는 APP 방식을 이용하여 본인인증 요청을 전송합니다.

주어진 아이디에 대응되는 본인인증 내역을 조회합니다.

주어진 조건에 맞는 본인인증 내역들을 페이지 기반으로 조회합니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
Carrier: "SKT" | "KT" | "LGU" | ...
통신사
ChannelNotFoundError: { type, message }
요청된 채널이 존재하지 않는 경우
ConfirmIdentityVerificationBody: { storeId, otp }
본인인증 확인을 위한 입력 정보
ConfirmIdentityVerificationError: ForbiddenError | IdentityVerificationAlreadyVerifiedError | IdentityVerificationNotFoundError | ...
ConfirmIdentityVerificationResponse: { identityVerification }
본인인증 확인 성공 응답
FailedIdentityVerification: { status, id, channel, ... }
실패한 본인인증 내역
ForbiddenError: { type, message }
요청이 거절된 경우
Gender: "MALE" | "FEMALE" | "OTHER"
성별
GetIdentityVerificationError: ForbiddenError | IdentityVerificationNotFoundError | InvalidRequestError | ...
GetIdentityVerificationsBody: { page, sort, filter }

본인인증 내역 다건 조회를 위한 입력 정보

GetIdentityVerificationsError: ForbiddenError | InvalidRequestError | UnauthorizedError
GetIdentityVerificationsResponse: { items, page }
본인인증 내역 다건 조회 성공 응답 정보
IdentityVerification: FailedIdentityVerification | ReadyIdentityVerification | VerifiedIdentityVerification
본인인증 내역
IdentityVerificationAlreadySentError: { type, message }
본인인증 건이 이미 API로 요청된 상태인 경우
IdentityVerificationAlreadyVerifiedError: { type, message }
본인인증 건이 이미 인증 완료된 상태인 경우
IdentityVerificationFailure: { reason, pgCode, pgMessage }
본인인증 실패 정보
IdentityVerificationFilterCustomerInput: { name, birthYear, birthMonth, ... }
본인인증 다건 조회를 위한 고객 정보 입력 정보
IdentityVerificationFilterInput: { storeId, timeRangeField, from, ... }
본인인증 다건 조회를 위한 입력 정보
IdentityVerificationMethod: "SMS" | "APP"
본인인증 방식
IdentityVerificationNotFoundError: { type, message }
요청된 본인인증 건이 존재하지 않는 경우
IdentityVerificationNotSentError: { type, message }
본인인증 건이 API로 요청된 상태가 아닌 경우
IdentityVerificationOperator: "SKT" | "KT" | "LGU" | ...
본인인증 통신사
IdentityVerificationRequestedCustomer: { id, name, phoneNumber, ... }
요청 시 고객 정보
IdentityVerificationSortBy: "REQUESTED_AT" | "VERIFIED_AT" | "FAILED_AT" | ...
본인인증 내역 정렬 기준
IdentityVerificationSortInput: { by, order }
본인인증 내역 다건 조회 시 정렬 조건
IdentityVerificationStatus: "READY" | "VERIFIED" | "FAILED"
본인인증 상태
IdentityVerificationTimeRangeField: "REQUESTED_AT" | "VERIFIED_AT" | "FAILED_AT" | ...
본인인증 다건 조회 시, 시각 범위를 적용할 필드
IdentityVerificationVerifiedCustomer: { id, name, operator, ... }
인증된 고객 정보
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

MaxTransactionCountReachedError: { type, message }
결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보
PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보
PgCompany: "INICIS" | "NICE" | "KCP" | ...
PG사
PgProvider: "HTML5_INICIS" | "PAYPAL" | "PAYPAL_V2" | ...
PG사 결제 모듈
PgProviderError: { type, message, pgCode, ... }
PG사에서 오류를 전달한 경우
PortOneVersion: "V1" | "V2"
포트원 버전
ReadyIdentityVerification: { status, id, channel, ... }
준비 상태의 본인인증 내역
ResendIdentityVerificationError: ForbiddenError | IdentityVerificationAlreadyVerifiedError | IdentityVerificationNotFoundError | ...
ResendIdentityVerificationResponse: { }
본인인증 요청 재전송 성공 응답
SelectedChannel: { type, id, key, ... }
(결제, 본인인증 등에) 선택된 채널 정보
SelectedChannelType: "LIVE" | "TEST"
채널 타입
SendIdentityVerificationBody: { storeId, channelKey, customer, ... }
본인인증 요청을 위한 입력 정보
SendIdentityVerificationBodyCustomer: { id, name, phoneNumber, ... }
본인인증 요청을 위한 고객 정보
SendIdentityVerificationError: ChannelNotFoundError | ForbiddenError | IdentityVerificationAlreadySentError | ...
SendIdentityVerificationResponse: { }
본인인증 요청 전송 성공 응답
SortOrder: "DESC" | "ASC"
정렬 방식
UnauthorizedError: { type, message }
인증 정보가 올바르지 않은 경우
VerifiedIdentityVerification: { status, id, channel, ... }
완료된 본인인증 내역