Page tree

Overview

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

The Validate MFA Phone Device API validates a phone number to use for Multi-Factor Authentication (MFA). 

You can enter spaces and special characters for the phone number.


Sample request

POST https://api.armor.com/usersecurity/validatemfaphone

Request {
   "MfaPhone":"555-555-5555",
   "MfaPhoneCountryCode":"1",
   "UserName":"user@example.com",
   "IsValid":false
   "PhoneExt": 12345	
}

Input

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

API Call / URLMethod / Type
/usersecurity/validatemfaphonePOST

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

ParameterDescriptionFormatRequired or optionalExample
MfaPhoneA phone numberIntegerRequired555-555-5555
MfaPhoneCountryCodeThe country code for your phone numberIntegerRequired1
UserNameYour AMP usernameStringRequireduser@example.com
IsValid

The validation status of your phone number

You must enter false so that Armor can test and validate your phone number.

BooleanRequiredfalse
PhoneExtThe extension for your phone numberIntegerOptional12345

Sample return

StatusResponse
200
{
   "MfaPhone":"555-555-5555",
   "MfaPhoneCountryCode":"1",
   "UserName":"user@example.com",
   "IsValid":true
}
400
Bad Request