Confirm identity verification API
Confirms the identity verification based on the submitted verification ID and OTP number.
POST https://api.iamport.kr/certifications/otp/confirm/{imp_uid} Confirms the identity verification based on the submitted verification ID and OTP number.
Confirms the identity verification based on the submitted verification ID and OTP number.
If verification is successful, this return a response with the userโs name, phone number, carrier, gender, foreigner status, date of birth, CI, and DI values.
Parameters
Path
iโmport verification ID
Body
OTP number received via SMS
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 (CertificationAnnotation, optional)
imp_uid
* string
verification ID
merchant_uid
string
Order ID
pg_tid
string
PG verification ID
pg_provider
* string
PG provider
name
string
Name
gender
string
Gender
- male
- female
birthday
string
DOB
ISO8601 date in string format. YYYY-MM-DD (10-digit)
foreigner
* boolean
Foreigner status
When signing a Danal identity verification service contract, you must request to use foreigner identification service.
- true : foreigner
- false : not foreigner
phone
string
Mobile phone number
Returns mobile phone number with only numbers without special symbols. This attribute is omitted unless pre-approved by the carrier. For pre-approval from the carrier, send a request with your Danal CPID to cs@iamport.kr.
carrier
string
Mobile carrier
Requires pre-approval from the carrier (send a request with your Danal CPID to cs@iamport.kr).
- SKT
- KT
- LGT
- SKT_MVNO
- KT_MVNO
- LGT_MVNO
certified
* boolean
Whether verification is successful
certified_at
string
Verified at
(UNIX timestamp)
unique_key
string
Personal Identification Key (CI)
unique_in_site
string
Merchant Personal Identification Key (DI)
origin
string
URL of the web page where the identity verification process is processed
foreigner_v2
boolean
Foreigner status (nullable)
- true : foreigner
- false : not foreigner
Requires a separate request to use Danal identity verification service
400: Bad Request Missing or invalid parameter error
{
// Response
}
401: Unauthorized Missing or invalid access token
{
// Response
}
404: Not Found Result not found
{
// Response
}
500: Internal Server Error Danal server error
{
// Response
}
Response Model Schema
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