개발자센터

requestIdentityVerification 요청 형식

requestIdentityVerification 호출 시 사용되는 파라미터의 형식을 확인할 수 있습니다.

requestIdentityVerification 요청 데이터 정의

request: IdentityVerificationRequest
storeId: string

상점 아이디

포트원 계정에 생성된 상점을 식별하는 고유한 값으로 관리자 콘솔 > 연동 정보 우측 상단에서 확인할 수 있습니다.

identityVerificationId: string

본인인증 건 ID

  • 임의로 ID를 정하여 입력합니다.
  • 이미 본인인증이 완료된 identityVerificationId로 다시 본인인증을 시도하는 경우 실패합니다.
channelKey?: string

채널 키

포트원에 등록된 결제 채널 중 하나를 지정합니다.

관리자 콘솔 > 연동 정보에서 채널 연동 후 채널 키를 확인할 수 있습니다.

채널 키와 채널 그룹 ID 중 하나를 지정해야 합니다.

customer?: Customer
customerId?: string

구매자 ID

스마트로, KG이니시스 SBPS 일본결제에서 사용합니다.

토스페이먼츠와 스마트로의 빌링키 발급에서 사용합니다.

스마트로스마트로

스마트로에서는 20자 이내여야 합니다.

스마트로 간편결제에서 필수입니다. PINPAY 결제의 경우 고객별로 고유한 값이 필요합니다.

스마트로 빌링키 발급에서 필수입니다. 로마자, 숫자 사용 가능하며, 특수문자는 사용 불가능합니다.

KG이니시스KG이니시스

KG이니시스 SBPS 일본결제에서 필수입니다. 이 경우 30자 이내여야 합니다.

fullName?: string

구매자 전체 이름

fullName이 사용되는 PG에서 fullName이 없고 firstName과 lastName이 있는 경우 ${lastName} ${firstName}이 대신 사용됩니다.

나이스페이먼츠나이스페이먼츠

NICE페이먼츠에 전달됩니다. 최대 30바이트입니다. 알리페이 결제의 경우 필수입니다.

KG이니시스KG이니시스
웰컴페이먼츠웰컴페이먼츠

KG이니시스, 웰컴페이먼츠에서는 필수입니다. 최대 30바이트입니다.

NHN KCPNHN KCP

NHN KCP에 전달됩니다. 최대 30자입니다. 모바일에서 카드사 UI를 직접 호출할 경우 필수입니다.

스마트로스마트로

스마트로에서는 최대 30자입니다.

KSNETKSNET

KSNET에서는 필수입니다. 최대 50바이트입니다.

한국결제네트웍스한국결제네트웍스

한국결제네트웍스에 전달됩니다. 최대 100자입니다.

하이픈하이픈

하이픈에서는 필수입니다.

firstName?: string

구매자 성이 아닌 이름

페이팔에서 구매자 페이팔 계정 소유자의 이름을 지정합니다.

lastName?: string

구매자 성

페이팔에서 구매자 페이팔 계정 소유자의 성을 지정합니다.

phoneNumber?: string

구매자 휴대전화 번호

숫자만 입력합니다.

나이스페이먼츠나이스페이먼츠

NICE페이먼츠에 전달됩니다.

KG이니시스KG이니시스
웰컴페이먼츠웰컴페이먼츠

KG이니시스, 웰컴페이먼츠에서는 필수입니다.

NHN KCPNHN KCP

NHN KCP에 전달됩니다.

스마트로스마트로

스마트로에 전달됩니다.

email?: string

구매자 이메일 주소

올바른 형식의 이메일 주소여야 합니다.

나이스페이먼츠나이스페이먼츠

NICE페이먼츠에 전달됩니다.

KG이니시스KG이니시스
웰컴페이먼츠웰컴페이먼츠

KG이니시스, 웰컴페이먼츠에서는 필수입니다.

NHN KCPNHN KCP

NHN KCP에 전달됩니다. PC에서 카드사 UI를 직접 호출할 경우 필수입니다.

스마트로스마트로

스마트로에 전달됩니다. 최대 60자입니다.

address?: Address

구매자 주소

country?: Country

국가

ISO 3166-1 alpha-2 코드입니다.

addressLine1: string

주소 첫째 줄

addressLine2: string

주소 둘째 줄

city?: string

도시

province?: string

주, 도, 시

zipcode?: string

구매자 우편번호

gender?: Gender

구매자 성별

정보성 필드입니다.

"GENDER_MALE"

남성

"GENDER_FEMALE"

여성

"GENDER_OTHER"

기타

birthYear?: string

구매자 출생년도

"1990"과 같은 형식입니다.

KG이니시스 통합인증에서 flgFixedUser가 Y인 경우 필수입니다.

birthMonth?: string

구매자 출생월

"12", "07"과 같은 형식입니다.

KG이니시스 통합인증에서 flgFixedUser가 Y인 경우 필수입니다.

birthDay?: string

구매자 출생일

"25", "08"과 같은 형식입니다.

KG이니시스 통합인증에서 flgFixedUser가 Y인 경우 필수입니다.

firstNameKana?: string

구매자 일본어 성이 아닌 이름 후리가나(읽는 법)

KG이니시스 JPPG 일본 편의점 결제에서 필수입니다. 최대 20바이트입니다.

lastNameKana?: string

구매자 일본어 성 후리가나(읽는 법)

KG이니시스 JPPG 일본 편의점 결제에서 필수입니다. 최대 20바이트입니다.

windowType?: WindowTypes

환경 별 제공되는 결제/본인인증 창 유형

  • PG사에 따라 가능한 창 유형이 다릅니다.
  • 전달되지 않았을 때 결정되는 기본 창이 다릅니다.
  • 미입력 시, 해당 PG사의 기본 창 방식을 따릅니다.
pc?: WindowType

PC에서의 결제창 유형 IFRAME, REDIRECTION, POPUP 중 하나를 입력해주세요.

"IFRAME"
"POPUP"
"REDIRECTION"
"UI"
mobile?: WindowType

모바일에서의 결제창 유형 IFRAME, REDIRECTION, POPUP 중 하나를 입력해주세요.

"IFRAME"
"POPUP"
"REDIRECTION"
"UI"
redirectUrl?: string

리디렉션 방식에서 결제 완료 후 이동할 URL

결제사 페이지로 이동하여 진행하는 리디렉션 방식의 경우 필수로 설정해야 합니다. 대부분의 모바일 환경이 리디렉션 방식에 해당됩니다.

customData?: string

본인인증 정보와 함께 관리하고 싶은 고객사 커스텀 JSON 데이터

bypass?: IdentityVerificationBypass

PG사 본인인증 창 호출 시 PG사로 그대로 bypass할 값들의 모음

danal?: DanalIdentityVerificationBypass

다날 bypass 파라미터

CPTITLE?: string

고객사 서비스 URL 혹은 본인확인 기능 사용 경로

  • 본인확인 기능을 앱에서만 사용하는 경우 서비스 홈 URL 입력. Ex) m.login.MarketC.co.kr
  • 본인확인 기능을 사용하는 웹 페이지가 존재할 경우 해당 URL 입력. Ex) www.MarketA.co.kr
  • 웹 서비스 URL 자체가 존재하지 않는 경우 서비스 이름 (app 이름) 입력. Ex) 마켓A
  • 해당 값을 넘기지 않을 경우 포트원으로 default 값을 채웁니다.
AGELIMIT?: number

본인인증을 진행할 수 있는 최소 만 나이

해당 값을 채워서 요청할 경우 본인인증을 진행할 수 있는 최소 만 나이를 설정할 수 있습니다.

IsCarrier?: string

통신사 정보

인증 화면에서 해당 통신사만 활성화시킬 수 있습니다.

가능한 값: SKT, KTF, LGT, MVNO

여러 개의 통신사를 활성화시키려면 위 값들을 semicolon(;) 으로 이어야 합니다. ex) SKT;KTF

inicisUnified?: InicisUnifiedIdentityVerificationBypass

KG이니시스 bypass 파라미터

directAgency?: InicisUnifiedDirectAgency

단독 노출할 인증 업체 코드

인증 업체 선택 화면 없이 설정한 인증 업체를 통해 인증하도록 합니다.

flgFixedUser: InicisUnifiedFlgFixedUser

인증 창에서 고객 정보를 미리 채울지 여부

Y, N 중 하나를 입력해주세요.

Y인 경우 이름, 연락처, 출생년도, 출생월, 출생일을 필수로 입력해야 합니다.

"Y"
"N"
logoUrl?: string

인증 창에 표시할 로고 URL

인증 창 좌측 상단 KG이니시스 로고 대신 들어갈 로고의 URL입니다. 최적 크기는 가로 164px, 세로 28px입니다.

HTTPS URL을 입력합니다. (HTTP URL인 경우 표시되지 않을 수 있습니다.)

DI_CODE?: string

DI를 생성할 때 사용할 salt

FRGNDInfo?: string

성별 및 외국인 정보 별도 입력 여부

Y(기본값)인 경우 성별 및 외국인 정보를 제공하지 않는 일부 인증기관 사용 시 성별 및 외국인 정보 입력란을 표시합니다. 해당 정보는 인증 기관을 통해 검증되지 않습니다.

N인 경우 네이버, 카카오에서 사용자가 성별 및 외국인 정보를 입력하는 칸을 표시하지 않습니다.

kcpV2?: KcpV2IdentityVerificationBypass

KCP bypass 파라미터

web_siteid?: string

DI 생성 시 사용할 사이트 ID

popup?: Popup

팝업 관련 필드

UI가 팝업 창으로 열릴 때 적용되는 속성입니다.

center?: boolean

팝업 정중앙 표시 true로 설정하면 팝업이 브라우저 화면의 정중앙에 표시됩니다. 결제사 및 환경에 따라 적용되지 않을 수 있습니다.

iframe?: Iframe

결제창이 iframe 방식일 경우 결제창에 적용할 속성

dim?: boolean

false로 설정하면 결제창 배경이 투명해집니다.