API URL Endpoint: https://api.geniq.io/rest/v1/verify/{messageId}?code={code}
PARAMETER | FORMAT | REQUIRED | DESCRIPTION |
messageId | string | Yes | An unique Id that was previously returned by our API when sending out OTP SMS |
code | string | Yes | The OTP code that was sent to the recipient |
reference | string | Optional | An unique reference ID for keeping track of requests and responses |
Sample request using CURL:
$ curl -X POST https://api.geniq.io/rest/v1/verify/84ceac7a-6903-45e5-a2c8-ea3de55b3bc9?code=123456 \
-H 'Authorization: Basic dXNlcjE6cGFzczE=' \
-d "reference=12345"
Parameters returned in the API response:
PARAMETER | FORMAT | DESCRIPTION |
reference | string | If reference parameter is submitted during OTP SMS API request, the same value will be returned |
responseMessage | string | Response message returned from the API call |
responseCode | integer | Response code returned from the API call. Refer to section “Response Codes” for list of possible values |
Sample Response:
{
"reference":"12345",
"responseMessage":"Success",
"responseCode":"0"
}