Last 7 days, UTC

Average Latency
347ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time

Endpoints

HTTP 200 : generic_response POST/cancel
The generic error or success response JSON format.
						{
  "resp_code": 0
}						
cancel

Cancels the OTP for the user if any were issued.


Test console
Description
Parameter
string

the user id whose otp is to be cancelled
Example: user1

user

Required

string

the signature for this request
Example: fdf853403af8adfdc68946fa2fc2db1ee09de254

sig

Required

HTTP 200 : generic_response POST/configure
The generic error or success response JSON format.
						{
  "resp_code": 0
}						
configure

Setup or change your account secrets. Initial secrets are set to same as your account id, and is valid only for the configure API call. Your account id is same as the mashape provided public key. No other APIs are valid till configure is called. At anytime, the new secret and the last secret are valid (to help you transition). To completely obliterate the old secret, call this API again after the largest OTP validity time expires.


Test console
Description
Parameter
string

the secret to set for your account
Example: secret1

secret

Required

string

signature of this request
Example: 16335c2292a73ca62a38815806d4168396e58e65

sig

Required

HTTP 200 : gen_response POST/gen
response for the generate otp request
						{
  "resp_code": 0,
  "otp": "123456"
}						
gen

Generate an otp for the specified user. Issues an otp to user identified by "user id" for the specified validity seconds. Tag data if any is remembered and returned upton successful validation.


Test console
Description
Parameter
string

user for which to generate an otp
Example: user1

user

Required

string

seconds for which the password would be valid
Example: 300

validity

Required

string

the data to be returned on successful validation (maximun length: 128. string will be silently truncated beyond this length)
Example: return this to me

tagdata

Required

string

signature of this request
Example: 0d43a19a30718b74f974cdd296ec699eb916a644

sig

Required

HTTP 200 : verify_response POST/verify
						{
  "resp_code": 0,
  "tagdata": "tagged data if any on success"
}						
verify

Verify an otp and fetch the remembered tagged data if any on success. OTP is deleted upon validation, whether it was successful or otherwise.


Test console
Description
Parameter
string

user for which to validate otp
Example: user1

user

Required

string

the otp to validate with
Example: 533704

otp

Required

string

signature of this request
Example: 5840819554b7ef89636c64eb9fae412d85064b17

sig

Required

Consume this API completely for free!


By joining the mashape API marketplace you can start using One Time Password Service API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.