Page tree


In This Document 



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 - Get User Context API retrieves a user's password recovery context. A password recovery can take place via email or SMS. This API returns the user's preference for receiving a password recovery. 


Sample request

GET https://api.armor.com/recovery/context/user@example.com

Input

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

API Call / URLMethod / Type
/recovery/usercontext/{userName} GET

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 accountEmail addressRequireduser@example.com

Sample return

StatusResponse
200
{
 "isValid": true,
 "maskedPhoneNumber":
"(***) *** **55"
}
400
Bad Request