v1

latestOpenAPI 3.0.22026-07-2432112226.7 KB

Sandbox - SMS OTP

Sandbox - Verify OTP V2

SMS OTP version change is by introducing a new API version release.

Version changes usually need to be applied immediately to the latest version, in order to get a better API usage experience than the previous version.

The benefits you get if you use a newer version are as follows.

Decreasing processing time in API Request and Response
Improve feature in SMS: Blocking Request, Spam Check, Sequential Phone Number, and Blocked Numbers
Increase RPS in SMS (before 30rps to 50rps)
Better developer environment to support future developments
Improve logging and monitoring on our side
Improved dependencies and improved service stability

This method helps you to verify one-time password to destination number

The following table describes the msisdn option to be used as an input

Msisdn	Description	Response
6282123060007	Verify OTP Success	201 "OTP has been verified"
6282123060008	Invalid OTP	404 "OTP Not Found"
6282123060009	Exceeded time limit	422 "OTP cannot be verified because it has already reached the time limit"
6282123060010	Invalid OTP	400 "Invalid OTP"

post/v2/otp/verify/sandbox

Headers

app-idstring required

api-keystring required

Request body

msisdnstring required

This value is destination number. You need to include international prefix number.

otpstring required

Code received by destination number.

challengestring

This value is a category. You can verify OTP based on the same challenge.

Example request

{
  "msisdn": "6282123060001",
  "challenge": "update_account"
}

Response

Successful Response

messagestring required

Message

Example response

{
  "message": "OTP has been verified"
}