⌨️본인인증 완료 API

본인인증을 완료하는 API 입니다.

Deprecated

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

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

포트원거래번호와 SMS 인증번호를 이용하여 본인인증을 완료합니다.

본인인증을 완료합니다.

POST https://api.iamport.kr/certifications/otp/confirm/{imp_uid}

본인인증이 완료되면 대상자의 이름, 전화번호, 통신사, 성별, 외국인여부, 생년월일, CI, DI 값을 응답받을 수 있습니다.

\

Path Parameters

Name	Type	Description
imp_uid*	String	포트원 거래고유번호

Request Body

Name	Type	Description
otp*	String	SMS로 전송된 본인인증 번호

200: OK 성공

CertificationResponse

code integer

응답코드

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

message string

응답메세지

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

response (CertificationAnnotation, optional)

CertificationAnnotation

imp_uid * string

인증고유번호

merchant_uid string

주문번호

pg_tid string

PG사 인증결과 고유번호

pg_provider * string

본인인증 제공 PG사 명칭

name string

실명

gender string

성별

• male:남성

• female:여성

birthday string

생년월일

ISO8601 형식의 문자열. YYYY-MM-DD 10자리 문자열

foreigner boolean

외국인여부

다날 본인인증서비스 계약시 외국인 구분기능 추가 요청을 해주셔야 사용이 가능합니다

• true : 외국인

• false : 내국인

phone string

휴대폰번호

특수기호없이 숫자로만 구성된 휴대폰번호가 전달. 통신사 사전승인이 이뤄지지 않으면 phone 속성은 존재하지 않습니다. 통신사 사전승인이 필요하므로 **[e-mail] ** 로 다날 CPID 와 함께 사용승인 요청이 필요합니다.

carrier string

휴대폰번호의 통신사

통신사 사전승인이 필요하므로 **[e-mail] ** 로 다날 CPID 와 함께 사용승인 요청이 필요합니다.

• SKT

• KT

• LGT

• SKT_MVNO

• KT_MVNO

• LGT_MVNO

certified boolean

인증성공여부

certified_at string

인증처리시각 (UNIX timestamp)

unique_key string

개인 고유구분 식별키 (CI)

unique_in_site **string

가맹점 내 개인 고유구분 식별키 (DI)

origin string

본인인증 프로세스가 진행된 웹 페이지의 URL

foreigner_v2 boolean

외국인 여부(nullable)

• true : 외국인

• false : 내국인

다날 본인인증서비스 계약시 외국인 구분기능 추가 요청필요

400: Bad Request 인증번호를 누락하였거나 이미 인증처리가 완료된 건에 대해 재요청하는 경우

{
    // Response
}

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

{
    // Response
}

404: Not Found imp_uid 에 해당되는 요청건이 없는 경우

{
    // Response
}

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

{
    // Response
}

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "imp_uid": "string",
    "merchant_uid": "string",
    "pg_tid": "string",
    "pg_provider": "string",
    "name": "string",
    "gender": "string",
    "birth": 0,
    "birthday": "string",
    "foreigner": true,
    "phone": "string",
    "carrier": "SKT",
    "certified": true,
    "certified_at": 0,
    "unique_key": "string",
    "unique_in_site": "string",
    "origin": "string",
    "foreigner_v2": true
  }
}

Swagger Test Link

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