⌨️본인인증 요청 API

API를 이용하여 본인인증 프로세스를 시작합니다.

Deprecated

이 문서는 더 이상 관리되지 않습니다.

PortOne 개발자센터를 이용해주세요.

사용자 개인정보를 입력하여 SMS OTP번호 발송 API 입니다.

본인인증을 위한 SMS OTP 번호를 발송합니다.

POST https://api.iamport.kr/certifications/otp/request

사용자 개인정보를 API로 전달하여 통신사로부터 확인되는 경우 OTP(6자리 인증번호)를 사용자에게 SMS로 전달합니다. 통신사 승인을 받은 일부 가맹점에 한해 사용하실 수 있으며 현재 다날을 통해서만 서비스되고 있습니다.

본인인증 대상자의 성명, 생년월일 + 주민등록 뒷부분 첫 자리, 휴대폰번호, 통신사 정보를 가맹점에서 직접 입력받아 API를 요청하면 됩니다. 전달된 개인정보가 올바른 경우 해당 휴대폰으로 인증번호 SMS가 전송됩니다.

HTTP Status 200응답 시 imp_uid 가 응답데이터로 전달되며 SMS전송된 인증번호를 /certifications/otp/confirm/{imp_uid} API 로 요청주시면 최종 본인인증 프로세스가 완료됩니다.

Request Body

Name	Type	Description
name*	String	본인인증 대상자 성명
phone*	String	휴대폰번호 특수기호가 삽입되어도 무방합니다.
birth*	String	생년월일 YYYYMMDD 6자리 특수기호가 삽입되어도 무방합니다.
gender_digit*	String	성별구분코드 주민번호 뒷부분 첫자리
carrier*	String	통신사구분코드 SKT KT LGT
is_mvno	Boolean	알뜰폰 사용 여부
company	String	가맹점 서비스명칭
merchant_uid	String	주문번호
pg	String	PG사 구분코드

200: OK 성공

CertificationOTPResponse

code * integer

응답코드

0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다

message * string

응답메세지

code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response (CertificationOTPAnnotation, optional)

CertificationOTPAnnotation

imp_uid * string

포트원 거래고유번호

400: Bad Request 대상자 개인정보 중 일부가 누락되었거나 올바르지 않은 경우

{
    // Response
}

401: Unauthorized 인증 Token이 전달되지 않았거나 유효하지 않은 경우

{
    // Response
}

500: Internal Server Error 처리 중 다날서버 응답오류 등 오류가 발생한 경우

{
    // Response
}

주요 요청 파라미터 상세 설명

gender_digit * string

셩별구분코드

주민등록번호 13자리 중 7번째 자리

2000년 이전 출생자는 1 또는 2, 2000년 이후 출생자는 3 또는 4

carrier * string

통신사 구분코드

알뜰폰 사용자의 경우 carrier파라미터 SKT, KT, LGT 중 하나를 지정한 후

is_mvno : true 로 설정

company * string

가맹점 서비스명칭

KISA에서 대상자에게 발송하는 SMS에 안내될 서비스 명칭

pg string

PG사 구분코드

다날 상점아이디를 2개 이상 동시에 사용하시려는 경우 설정하시면 됩니다.

danal.{상점아이디} 형태로 지정

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "imp_uid": "string"
  }
}

Swagger Test Link

https://api.iamport.kr/#!/certifications/requestOTP