Page tree




In This Document 


Was this document useful? 
Your Rating:
Results:
1 Star2 Star3 Star4 Star5 Star
2 rates


Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.



Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Password Recovery - Complete SMS Request API redeems an SMS-based OTP for a password reset token. This token can be redeemed for a password reset grant token using the recovery validation API call (Password Recovery - Validate). 


Sample request

POST https://api.armor.com/recovery/completesms
{
    "username":"user@example.com",
    "otp":"123456",
    "token":"abcd1234"
}



Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/recovery/completesms POST

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
usernameYour AMP username, which is the email address associated with your accountStringRequireduser@example.com
otpThe code generated from the Password Recovery - Initiate SMS Request API call.IntegerRequired123456
tokenThe one-time password received via text message.GUIDRequiredabcd1234



Sample return

StatusResponse
200
{
 "isValid": true,
 "token": "abcd1234",
 "message": "Ok"
}
400
Bad Request