About MFA Status
Check the current user's Multi-Factor Authentication (MFA) session status based off the deviceId and mfaId that was returned as part of the MFAAuthenticate. The status informs developers if the mfaId is still valid, or if the user needs to go through MFA Authenticate again before attempting to use one of the 4 MFA Protected Endpoints. If the MFAStatus call returns a success, the user’s API session is still trusted, and can be bypassed, otherwise, MFAAuthenticate should be performed.
Example
Request
<API_URL_EndPoint>/MFAStatus.json
data={
"mfaId" : "!aTdAZjLbxn7-z8GiNyokJfp9ybYEKJd1KM1K2eU",
"deviceId" : "916E333F-1BBC-4471-946D-8059DB9488B6"
}
Response
data={
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"isTrusted" : true
}
}
Resources
Parameters
Request parameters
Field Name | Description | Required? |
---|---|---|
mfaId | The ID that is returned after successfully calling the MFA Authenticate API. | Yes |
deviceId | String(100) - The ID defined by the user to identify the MFA device. | Yes |