Two-factor authentication

You can find every API used by the two-factor authentication product on a single page.
It walks through service name management, requesting and verifying a verification code, and looking up results, in that order.

Use the service name management API when you want to show a service name in the message that carries the verification code.

Register a service name

POST/api/verify/v1/2fa/service/regist

Registers the service name shown in verification code messages. The service name can be up to 20 bytes (Korean characters count as 2 bytes; letters, digits, and spaces count as 1 byte).

Body Parameters

{}JSON

serviceName

RequiredString

The service name.

userRef

String

A custom reference value you define.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

data

Object

The 2FA response data.

resultMsg

String

A detailed description of the call result.

userRef

String

The user reference value you passed in the request.

Request example

curl -X POST "https://mars.ibapi.kr/api/verify/v1/2fa/service/regist" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "serviceName": "비즈고",
    "userRef": "verify-service-regist-001"
  }'

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"SUCCESS",
    "resultMsg":"성공",
    "serviceName":"비즈고",
    "userRef":"verify-service-regist-001"
  }
}

Look up service names

POST/api/verify/v1/2fa/service

Looks up the currently registered service name. If no service name is registered, an empty string is returned.

Body Parameters

{}JSON

userRef

String

A custom reference value you define.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

data

Object

The 2FA response data.

resultMsg

String

A detailed description of the call result.

regDate

String

The time the service name was registered.

userRef

String

The user reference value you passed in the request.

Request example

curl -X POST "https://mars.ibapi.kr/api/verify/v1/2fa/service" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "userRef": "verify-service-list-001"
  }'

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"SUCCESS",
    "resultMsg":"성공",
    "serviceName":"비즈고",
    "regDate":"2026-03-31 10:39:11",
    "userRef":"verify-service-list-001"
  }
}

Delete a service name

POST/api/verify/v1/2fa/service/delete

Deletes the registered service name. Verification messages sent afterwards no longer include the service name.

Body Parameters

{}JSON

userRef

String

A custom reference value you define.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

data

Object

The 2FA response data.

resultMsg

String

A detailed description of the call result.

userRef

String

The user reference value you passed in the request.

Request example

curl -X POST "https://mars.ibapi.kr/api/verify/v1/2fa/service/delete" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "userRef": "verify-service-delete-001"
  }'

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"SUCCESS",
    "resultMsg":"성공",
    "userRef":"verify-service-delete-001"
  }
}

Request a verification code

POST/api/verify/v1/2fa/request

Requests a verification code. The code is 6 digits and stays valid for 3 minutes. You can request it up to 5 times within those 3 minutes.

Body Parameters

{}JSON

RequiredString

The recipient number.

authNumber

String

A static OTP you specify when you need a fixed verification code.

userRef

String

A custom reference value you define.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

data

Object

The 2FA response data.

resultMsg

String

A detailed description of the call result.

requestId

String

The requestId you use for the verification request.

userRef

String

The user reference value you passed in the request.

Request example

curl -X POST "https://mars.ibapi.kr/api/verify/v1/2fa/request" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "01000000000",
    "userRef": "verify-request-001"
  }'

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"SUCCESS",
    "resultMsg":"성공",
    "requestId":"58f5edaf-0fc1-3ac7-8fe0-c4453abf0ba1",
    "userRef":"verify-request-001"
  }
}

Verify

POST/api/verify/v1/2fa/verify

Verifies the code the user received.

Body Parameters

{}JSON

authNumber

RequiredString

The verification code.

RequiredString

The recipient number.

requestId

String

The verification key returned by the verification code request.

userRef

String

A custom reference value you define.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

data

Object

The 2FA response data.

resultMsg

String

A detailed description of the call result.

userRef

String

The user reference value you passed in the request.

Request example

curl -X POST "https://mars.ibapi.kr/api/verify/v1/2fa/verify" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "authNumber": "123456",
    "to": "01000000000",
    "requestId": "58f5edaf-0fc1-3ac7-8fe0-c4453abf0ba1",
    "userRef": "verify-check-001"
  }'

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"SUCCESS",
    "resultMsg":"성공",
    "requestId":"58f5edaf-0fc1-3ac7-8fe0-c4453abf0ba1",
    "userRef":"verify-check-001"
  }
}

Look up results

POST/api/verify/v1/2fa/logs

Looks up the 2FA result history by request date.

Body Parameters

{}JSON

requestDate

RequiredString

The date the verification code was requested.

requestId

String

The verification key.

userRef

String

A custom reference value you define.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

data

Object

The 2FA response data.

resultMsg

String

A detailed description of the call result.

userRef

String

The user reference value you passed in the request.

list

Array

The list of results.

requestDate

String

The date and time the verification code was requested.

status

String

The verification status.

verifyDate

String

The date and time verification succeeded.

Request example

curl -X POST "https://mars.ibapi.kr/api/verify/v1/2fa/logs" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "requestDate": "20260331",
    "requestId": "58f5edaf-0fc1-3ac7-8fe0-c4453abf0ba1",
    "userRef": "verify-logs-001"
  }'

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"SUCCESS",
    "resultMsg":"성공",
    "userRef":"verify-logs-001",
    "list": [
      {
        "requestDate":"2026-03-31 09:39:38",
        "status":"PENDING",
        "verifyDate":"",
        "requestId":"58f5edaf-0fc1-3ac7-8fe0-c4453abf0ba1"
      },
      {
        "requestDate":"2026-03-31 09:40:02",
        "status":"SUCCESS",
        "verifyDate":"2026-03-31 09:41:10",
        "requestId":"58f5edaf-0fc1-3ac7-8fe0-c4453abf0ba2"
      }
    ]
  }
}