OTP (One Time Password)

It is a pin or dynamic password, is a password that is valid for only one login session or transaction, on a computer system or other digital device.

One-Time Passwords help growing startups and agile enterprises enhance customer experience and realize new business outcomes at scale. With the most comprehensive suite of communication channels, a global platform, and expert support, you can abstract the complexity of communications and innovate faster.

Request OTP

It is part of ANTS account security offerings, the OTP API makes it simple to add user verification to various application and use cases. It supports codes sent via SMS.

Sequence Diagram

You can start creating HTTP request as this following:

Request body should be indicated with these following parameters

Request JSON

{
 	"otcId": "0DC8E7AD-0168-440C-AF10-BF556B164D83",
 	"mobile": "66123456789",
  "notifyUrl": "https://testSendOTP",
  "notifyContentType": "application/json",
  "callbackData":"OTP Data"
}

OTP Response

The response will look like:

{
    	"otcId": "0DC8E7AD-0168-440C-AF10-BF556B164D83",
    	"otpId": "0c342e74-a9c7-4bbd-8da4-b36a49bbc0d6",
    	"referenceCode": "IpA6k",    	
    	"success": {
        		"message": "success",
        		"description": ""
    	}
}

ResendOTP

It is part of ANTS account security offerings, the OTP API makes it simple to add user verification to various application and use cases. It supports codes sent via SMS again.

Sequence Diagram

You can start creating HTTP request as this following:

Request body should be indicated with these following parameters

Request JSON

{
 	"otcId": "0DC8E7AD-0168-440C-AF10-BF556B164D83",
}

Response

The response will look like:

{
    	"otcId": "0DC8E7AD-0168-440C-AF10-BF556B164D83",
    	"otpId": "0c342e74-a9c7-4bbd-8da4-b36a49bbc0d6",
    	"referenceCode": "IpA6k",    	
    	"success": {
        		"message": "success",
        		"description": ""
    	}
}

Verify OTP

Use to verify set of password and verify owner of the account.

Sequence Diagram

You can start using HTTP request as following details:

Request body should be indicated with these following parameter

The request JSON will look like:

{
    "otpId": "0c342e74-a9c7-4bbd-8da4-b36a49bbc0d6",
   	"otpCode": "79895"
    "notifyUrl": "https://testSendOTP",
    "notifyContentType": "application/json",
    "callbackData":"OTP Data"
}

OTP Response

The response will look like:

{
    	"otpId": "0c342e74-a9c7-4bbd-8da4-b36a49bbc0d6",
    	"result": true,
    	" isErrorCount": false,
    	"isExprCode": false
}

Response Status

While using our API you may encounter certain status and error codes that you need to understand or troubleshoot.

Each code with the descriptions will guild you to take action steps you need to take in case you are looking for a resolution of the problem.

Status Code

Beside HTTP status code standard, there will be also API response status.

The response status will look link

{
	  "error": {
		"message": "Invalid OTP Config",
		"description": ""
             }
}

Status Code

PreviousStatus and Error codes NextSMS 2 WAY Interactive

Last updated 4 years ago