개발자센터

본인인증 요청 파라미터

본인인증 요청 파라미터를 확인할 수 있습니다.

본인인증 요청 파라미터 정의

storeId * string

상점 ID

  • 포트원에서 채번하는 상점 ID입니다.
  • 관리자콘솔의 결제 연동 페이지에서 확인하실 수 있습니다.

identityVerificationId * string

본인인증건 고유 번호

  • 고객사가 채번하는 본인인증 건에 대한 고유 번호입니다.
  • 이미 본인인증이 완료된 identityVerificationId로 다시 본인인증을 시도하는 경우 에러가 발생합니다.

channelKey string

채널 키

콘솔에서 표시되는 채널 키입니다.

pgProvider 파라미터가 없는 경우에 필수로 존재해야 합니다. 두 파라미터가 모두 존재하는 경우 channelKey를 적용하니 둘 중 하나만 제공해주세요.

pgProvider string (Deprecated 예정)

PG사 구분코드 (2024년 09월 30일부터 사용이 불가능한 파라미터 입니다.)

channelKey 파라미터가 없는 경우에 필수로 존재해야 합니다.

가능한 PG사 코드는 아래를 참고해주세요.

isTestChannel boolean (Deprecated 예정)

테스트 채널 정보로 결제할지 여부 (2024년 09월 30일부터 사용이 불가능한 파라미터 입니다.)

미입력 시 기본값은 false입니다.

선택하신 채널이 테스트 채널이 아닌 경우 에러가 발생합니다.

customer object

고객 정보

  • customerId string

    구매자 고유 ID

  • fullName string

    구매자 전체 이름

    fullName과 firstName / lastName이 모두 입력된 경우 fullName으로 기록됩니다.

  • firstName string

    구매자 이름

    firstName을 입력하는 경우 lastName도 필수로 입력해야 합니다. fullName이 없고, firstName과 lastName이 존재하는 경우 {firstName} {lastName}으로 저장됩니다.

  • lastName string

    구매자 성

    lastName을 입력하는 경우 firstName도 필수로 입력해야 합니다.

  • phoneNumber string

    구매자 연락처

  • email string

    구매자 이메일 주소

    유효한 이메일 주소를 입력해주세요.

  • address object

    구매자 주소

    • country string

      국가

    • addressLine1 * string

      일반주소

    • addressLine2 * string

      상세주소

    • city string

      도시

    • province string

      주, 도, 시

  • zipcode string

    구매자 우편번호

  • gender string

    구매자 성별

    MALE, FEMALE, OTHER 중 하나를 입력해주세요.

  • birthYear string

    구매자 출생년도

    ex. "1990" 같은 형식으로 입력해주세요.

  • birthMonth string

    구매자 출생월

    ex. "12", "07" 같은 형식으로 입력해주세요.

  • birthDay string

    구매자 출생일

    ex. "25", "08" 같은 형식으로 입력해주세요.

windowType object

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

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

  • pc string

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

  • mobile string

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

redirectUrl string

리디렉션 방식에서 본인인증 프로세스 완료 후 이동될 고객사 URL

  • 본인인증 창이 새로운 창으로 리다이렉트 되어 본인인증이 진행되는 방식인 경우 필수 설정 항목입니다.
  • 대부분의 모바일 환경에서 본인인증 창 호출시 필수 항목입니다.
  • 리다이렉트 환경에서 해당 필드 누락시 에러가 발생합니다.

customData object

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

bypass oneof object

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

  • danal object

    다날 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 object

    KG이니시스 bypass 파라미터

    • directAgency string

      단독 노출할 인증 업체 코드

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

    • flgFixedUser * string

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

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

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

    • logoUrl string

      인증 창에 표시할 로고 URL

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

      HTTP URL인 경우 로고가 표시되지 않을 수 있습니다.