MFAAuthenticate

About MFA Authenticate

Multi Factor Authentication (MFA) is used to validate the token sent to the user’s mobile device via the mfaChallenge API. This API validates the challenge ID, and the token that was sent to the users mobile device. Upon success, the user’s session is marked as a trusted.

If rememberMe is set to true, the trusted session expires in 30 days. Else, it expires when the user logs out. Use the MFA Status API to check if the session has expired.

Note:

• deviceId is indicative of the user's unique device where they receive the challenge and subsequent authentication token. It is recommended to assign a unique identifier for each user, and store this information for future reference.
• mfaId response parameter will only be returned if rememberMe is true.

MFA login process

Login with an MFA trusted API session is a three-step process:

1. Sign in with Login to generate a sessionId.
2. Create a MFA challenge ID and send a token to your mobile device with MFAChallenge.
3. Validate the challenge ID and token with MFAAuthenticate. At this point, the login sessionId is MFA trusted.

Note: See Multi-factor authentication (MFA)/2-step verification in the Bill.com Help for more information about all the security measures in place for your Bill.com account operations.

Example

Request

<API_URL_EndPoint>/MFAAuthenticate.json

data={
  "challengeId" : "!ak9txcIMmPsky0OBLE9KIZ3MtZexYcZtGo6FOCGATCYk",
  "token" : "123-456",
  "deviceId" : "916E333F-1BBC-4471-946D-8059DB9488B6",
  "machineName" : "Bob's iPhone",
  "rememberMe" : true
}

Response

data={
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "mfaId" : "!aTdAZjLbxn7-z8GiNyokJfp9ybYEKJd1KM1K2emUdvoU"
  }
}

Resources

• Authentication Workflow
• MFA Status

Parameters

Request parameters