request-identity-verification-api.mdx

title	description
Request identity verification API

import Details from "/components/gitbook/Details.astro"; import Swagger from "/components/gitbook/swagger/Swagger.astro"; import SwaggerDescription from "/components/gitbook/swagger/SwaggerDescription.astro"; import SwaggerParameter from "/components/gitbook/swagger/SwaggerParameter.astro"; import SwaggerResponse from "/components/gitbook/swagger/SwaggerResponse.astro"; import Tab from "/components/gitbook/tabs/Tab.astro"; import Tabs from "/components/gitbook/tabs/Tabs.astro"; import Hint from "/components/Hint.astro";

Sends OTP number via SMS confirming the user's identity based on the submitted personal information.

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** **Mobile number**

May contain special characters.

**DOB**

**`YYYYMMDD (6-digit)`**

May contain special characters.

**Gender code**

7th digit of 13-digit social security number

**Carrier code**

**`SKT`**

**`KT`**

**`LGT`**

**Budget phone?** **Merchant service name** **Order ID** **PG code**

Responses

**`code`** **\*** **integer**

    **Response code**

    0: success, Not 0: check the message

    **`message`** <mark style="color:red;"> **\*** </mark> <mark style="color:green;"> **string** </mark>

    **Response message**

    A non-zero code includes a message like 'Invalid payment info'.

    **response** <mark style="color:red;"> **(CertificationOTPAnnotation, optional)** </mark>
  </Tab>
</Tabs>

<Tabs>
  <Tab title="CertificationOTPAnnotation">
    **`imp_uid *`` `** <mark style="color:green;"> **`String`** </mark>

    **`i'mport verification ID`**
  </Tab>
</Tabs>

```ts { // Response } ``` ```ts { // Response } ``` ```ts { // 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

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

**Swagger Test Link**

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