Request Possession Verification Code

Request Possession Verification Code API

Sends a verification code to the verification target (mobile phone number or email address). The number of digits in the verification code depends on the channel. (SMS 6 digits / Email 4 digits)

Basic Information

POST /sms-sender/v3.2/occupancy_auth/send_code
Host:
   https://api.gate8.com (SANDBOX)
   https://api.onstove.com (LIVE)
Content-Type: application/json

Request

Header

Body

Response

Body

Value

Sample

Request

// Request possession verification code
curl -L -X POST 'https://api.gate8.com/sms-sender/v3.2/occupancy_auth/send_code' \
-H 'Content-Type: application/json' \
-H "Caller-Id: {{caller-id}}" \
-H 'Caller-Detail: f248a284-7e61-4dcf-a111-a394050e9555' \
-H 'Authorization: Bearer {{API accessToken}}' \
-d '{
    "channel":"email",
    "to":"user@example.com",
    "locale":"ko"
}'

Response

// Success - sms
{
    "code": 0,
    "message": "OK",
    "value": {
        "channel": "sms",
        "code_length": 6,
        "expires_in": 180
    }
}

// Success - email
{
    "code": 0,
    "message": "OK",
    "value": {
        "channel": "email",
        "code_length": 4,
        "expires_in": 600
    }
}

// Failure - parameter error
{
    "code": 70100,
    "message": "invalid parameter"
}

Return Code

Please check and handle API errors on the server side

• The front-end should only expose success or verification failure

Supported Countries for Possession Verification

When requesting with channel=sms, messages can only be sent to the countries below.

Sending Templates

These are the phrases and email formats actually delivered to users. Phrases and templates are subject to change.

SMS Phrase

Valid for 3 minutes, and the sending language is automatically determined based on the country code of the number. (Korea = Korean / Others = English)

Email Template

Valid for 10 minutes, and the sending language is determined by the locale value (ko / en).