Request identity verification API
Sends OTP number via SMS confirming the userโs identity based on the submitted personal information.
POST https://api.iamport.kr/certifications/otp/request Sends OTP number confirming user's identity via SMS.
Sends OTP number confirming user's identity via SMS.
If the userโs personal information is passed to the API and verified by the carrier, an OTP (6-digit verification number) is sent to the user via SMS. This is only supported by some merchants who have been pre-approved by the carrier, and is currently only being serviced through Danal.
You can call the API by directly entering the name, date of birth + 7th digit of social security number, mobile phone number, and carrier information from the merchant. If the transmitted personal information is correct, a verification code SMS is sent to the mobile phone.
When you receive an HTTP Status 200 response, it contains the verification ID (imp_uid
) in the response body. To complete the verification process, call the /certifications/otp/confirm/{imp_uid} API with the OTP number.
Parameters
Body
User name
May contain special characters.
YYYYMMDD (6-digit)
May contain special characters.
7th digit of 13-digit social security number
SKT
KT
LGT
Budget phone?
Merchant service name
Order ID
PG code
Responses
200: OK Success
code
* integer
Response code
0: success, Not 0: check the message
message
* string
Response message
A non-zero code includes a message like โInvalid payment infoโ.
**response ** (CertificationOTPAnnotation, optional)
imp_uid *``
String
i'mport verification ID
400: Bad Request Missing or invalid parameter error
{
// Response
}
401: Unauthorized Missing or invalid access token
{
// Response
}
500: Internal Server Error Danal server error
{
// Response
}
Key request parameter description
gender_digit
*
String
Gender code
7th digit of 13-digit social security number
1 or 2 for those born before 2000, 3 or 4 those born on or after 2000 (odd: male, even: female)
carrier
*
String
Carrier code
For budget phone users, set
carrier
to one of SKT, KT, or LGT, and set
is_mvno : true
company
*
String
Merchant service name
Service name to use in the SMS sent by KISA
pg``
String
PG code
Specify this value as follows only when you are using multiple Danal Merchant IDs.
danal.{Merchant ID}
Response Model Schema
Response Model Schema
{
"code": 0,
"message": "string",
"response": {
"imp_uid": "string"
}
}
Swagger Test Link