Page tree


Knowledge Base



Feedback


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 - Initiate SMS Request API initiates a password recovery for a user account. The user will receive an SMS-based OTP to the primary phone number on the user account. 

Sample Request

POST https://api.armor.com/recovery/initiatesms
{
    "username":"user@example.com"
}

Input

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

API Call / URLMethod / Type
/recovery/initiatesms 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 accountEmail addressRequireduser@example.com

Sample return

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