Skip to main content

Request

[GET]
{{baseUrl}}/api/v1/messaging/otp/validate
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>

Query parameter

ParameterTypeDescriptionRequired
codestringOTP received from userrequired
reference_idstringID to identify the OTPrequired

Response Sample

Response
{
  "entity": {
    "valid": true
  }
}

Response Fields

FieldTypeDescription
entityobjectContains the OTP validation result
entity.validbooleantrue if the OTP code is correct and has not expired; false otherwise

Test Credentials for Sandbox

Kindly use this Test OTP in sandbox Environment OTP = 1234