본인인증 관련 API
본인인증에 관련된 API 를 확인할 수 있습니다.
⌨ 본인인증 내역 단건조회
GET https://api.portone.io/identity-verifications/{id} 본인인증 내역 조회
본인인증 내역 조회
주어진 아이디에 대응되는 본인인증 내역을 조회합니다.
Parameters
Path
본인인증 내역 아이디
Query
상점 아이디 (접근 권한이 있는 상점 아이디 입력 가능, 미 입력시 토큰에 담긴 상점 아이디를 사용)
Responses
200 성공 응답으로 본인 인증 객체를 반환합니다.
status * string
본인인증 상태 (READY, VERIFIED, FAILED)
id * string
본인인증 내역 아이디
channel SelectedChannel
채널 정보
SelectedChannel
SelectedChannel
type * string
채널 타입 (LIVE, TEST)
id string
채널 아이디
key string
채널 키
name string
채널 명
pgProvider * string
PG사 (DANAL)
pgMerchantId * string
PG사 고객사 식별 아이디
customData string
사용자 지정 데이터
requestedAt * string
본인인증 요청 시각
updatedAt * string
업데이트 시각
statusChangedAt * string
상태 업데이트 시각
requestedCustomer * RequestedCustomer
(status - READY, FAILED 일 때만 존재)
요청 시 고객 정보
RequestedCustomer
RequestedCustomer
id string
식별 아이디
name string
이름
phoneNumber string
핸드폰 번호. 특수 문자(-) 없이 숫자로만 이루어진 번호 형식
verifiedCustomer * VerifiedCustomer
(status - VERIFIED 일 때만 존재)
인증된 고객 정보
VerifiedCustomer
VerifiedCustomer
id string
식별 아이디
name * string
이름
phoneNumber string
핸드폰 번호. 특수 문자(-) 없이 숫자로만 이루어진 번호 형식
birthDate * string
생년월일 (yyyy-MM-dd)
gender * string
성별
MALE, FEMALE, OTHER
isForeigner boolean
외국인 여부 (true - 외국인, false - 내국인)
ci * string
개인 고유 식별키
di * string
사이트별 개인 고유 식별키
verifiedAt * string
(status - VERIFIED 일 때만 존재)
본인인증 완료 시각
pgTxId * string
(status - VERIFIED 일 때만 존재)
본인인증 건 PG사 아이디
pgRawResponse * string
(status - VERIFIED 일 때만 존재)
PG사 응답 데이터
400 올바른 상점 아이디를 입력해주세요.
type * string
에러 타입
INVALID_REQUEST
message string
에러 메시지
401 인증 정보가 올바르지 않은 경우
type * string
에러 타입
UNAUTHORIZED
message string
에러 메시지
403 요청이 거절된 경우
type * string
에러 타입
FORBIDDEN
message string
에러 메시지
404 요청된 본인인증 건이 존재하지 않는 경우
type * string
에러 타입
IDENTITY_VERIFICATION_NOT_FOUND
message string
에러 메시지
⌨ 본인인증 요청 전송
POST https://api.portone.io/identity-verifications/{id}/send 본인인증 요청 전송
본인인증 요청 전송
본인인증 요청을 전송합니다.
SMS 방식을 이용할 경우 입력한 전화번호로 문자 메시지가 발송되며 APP 방식을 이용할 경우에는 PASS 앱으로 푸쉬 알람이 전송됩니다.
Parameters
Path
본인인증 내역 아이디
Body
상점 아이디 (접근 권한이 있는 상점 아이디 입력 가능, 미 입력시 토큰에 담긴 상점 아이디를 사용)
채널 키
고객 정보
사용자 정의 데이터
통신사
SKT, KT, LGU, SKT_MVNO, KT_MVNO, LGU_MVNO
본인인증 수단
SMS, APP
Responses
200 본인인증 요청 전송 성공 응답
400 요청된 입력 정보가 유효하지 않은 경우. 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
type * string
에러 타입
INVALID_REQUEST
message string
에러 메시지
401 인증 정보가 올바르지 않은 경우
type * string
에러 타입
UNAUTHORIZED
message string
에러 메시지
403 요청이 거절된 경우
type * string
에러 타입
FORBIDDEN
message string
에러 메시지
404 요청된 채널이 존재하지 않는 경우
type * string
에러 타입
CHANNEL_NOT_FOUND
message string
에러 메시지
409 이미 인증이 완료됐거나 API로 인증이 요청된 상태인 경우
type * string
에러 타입
IDENTITY_VERIFICATION_ALREADY_VERIFIED, IDENTITY_VERIFICATION_ALREADY_SENT
message string
에러 메시지
500 PG사에서 오류가 발생한 경우
type * string
에러 타입
PG_PROVIDER
pgCode * string
PG사 에러 코드
pgMessage * string
PG사 에러 메시지
id string
식별 아이디
name * string
고객 성명
phoneNumber * string
핸드폰 번호. 특수 문자(-) 없이 숫자로만 이루어진 번호 형식
identityNumber string
주민등록번호 앞 7자리 (SMS 방식의 경우 필수 입력)
⌨ 본인인증 확인
POST https://api.portone.io/identity-verifications/{id}/confirm 본인인증 확인
본인인증 확인
요청된 본인인증에 대한 확인을 진행하여 성공한다면 인증을 완료합니다.
SMS 방식의 경우에는 입력된 OTP가 실제 발송되었던 OTP와 일치하는지 확인하며, APP 방식의 경우 PASS 인증이 완료되었는지 여부를 검사합니다.
Parameters
Path
본인인증 내역 아이디
Body
상점 아이디 (접근 권한이 있는 상점 아이디 입력 가능, 미 입력시 토큰에 담긴 상점 아이디를 사용)
OTP (SMS 방식일 때만 입력, APP 방식은 입력하지 않음)
Responses
200 본인인증 확인 성공 응답
identityVerification * VerifiedIdentityVerification
본인인증 완료 상태 건
VerifiedIdentityVerification
VerifiedIdentityVerification
id * string
본인인증 내역 아이디
channel SelectedChannel
채널 정보
Channel
Channel
type * string
채널 타입 (LIVE, TEST)
id string
채널 아이디
key string
채널 키
name string
채널 명
pgProvider * string
PG사 (DANAL)
pgMerchantId * string
PG사 고객사 식별 아이디
customData string
사용자 지정 데이터
requestedAt * string
본인인증 요청 시각
updatedAt * string
업데이트 시각
statusChangedAt * string
상태 업데이트 시각
verifiedCustomer * VerifiedCustomer
인증된 고객 정보
VerifiedCustomer
VerifiedCustomer
id string
식별 아이디
name * string
이름
phoneNumber string
핸드폰 번호. 특수 문자(-) 없이 숫자로만 이루어진 번호 형식
birthDate * string
생년월일 (yyyy-MM-dd)
gender * string
성별
MALE, FEMALE, OTHER
isForeigner boolean
외국인 여부
ci * string
개인 고유 식별키
di * string
사이트별 개인 고유 식별키
verifiedAt * string
본인인증 완료 시각
pgTxId * string
본인인증 건 PG사 아이디
pgRawResponse * string
PG사 응답 데이터
400 요청된 입력 정보가 유효하지 않은 경우. 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
type * string
에러 타입
INVALID_REQUEST
message string
에러 메시지
401 인증 정보가 올바르지 않은 경우
type * string
에러 타입
UNAUTHORIZED
message string
에러 메시지
403 요청이 거절된 경우
type * string
에러 타입
FORBIDDEN
message string
에러 메시지
404 요청된 본인인증 건이 없거나 API로 본인인증이 요청된 상태가 아닌 경우
type * string
에러 타입
IDENTITY_VERIFICATION_NOT_FOUND, IDENTITY_VERIFICATION_NOT_SENT
message string
에러 메시지
409 본인인증 건이 이미 인증 완료된 상태인 경우
type * string
에러 타입
IDENTITY_VERIFICATION_ALREADY_VERIFIED
message string
에러 메시지
500 PG사에서 오류가 발생한 경우
type * string
에러 타입
PG_PROVIDER
pgCode * string
PG사 에러 코드
pgMessage * string
PG사 에러 메시지
⌨ 본인인증 요청 재전송 (SMS)
POST https://api.portone.io/identity-verifications/{id}/resend 본인인증 요청 재전송 (SMS)
본인인증 요청 재전송 (SMS)
본인인증 요청을 재전송합니다.
SMS 방식일 때에만 사용 가능하며, 기존 OTP가 만료되고 새로운 OTP가 전송됩니다.
Parameters
Path
본인인증 내역 아이디
Query
상점 아이디 (접근 권한이 있는 상점 아이디 입력 가능, 미 입력시 토큰에 담긴 상점 아이디를 사용)
Responses
200 본인인증 요청 재전송 성공 응답
400 요청된 입력 정보가 유효하지 않은 경우. 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
type * string
에러 타입
INVALID_REQUEST
message string
에러 메시지
401 인증 정보가 올바르지 않은 경우
type * string
에러 타입
UNAUTHORIZED
message string
에러 메시지
403 요청이 거절된 경우
type * string
에러 타입
FORBIDDEN
message string
에러 메시지
404 요청된 본인인증 건이 없거나 API로 본인인증이 요청된 상태가 아닌 경우
type * string
에러 타입
IDENTITY_VERIFICATION_NOT_FOUND, IDENTITY_VERIFICATION_NOT_SENT
message string
에러 메시지
409 본인인증 건이 이미 인증 완료된 상태인 경우
type * string
에러 타입
IDENTITY_VERIFICATION_ALREADY_VERIFIED
message string
에러 메시지
500 PG사에서 오류가 발생한 경우
type * string
에러 타입
PG_PROVIDER
pgCode * string
PG사 에러 코드
pgMessage * string
PG사 에러 메시지