v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
mfa

Validate phone for MFA setup

Validate the phone number for setting up MFA in the current organization. This validation requires the setupId and token from POST /v3/mfa/setup.

After the validation is complete, the phone number is registered for the MFA sign in operation.

There are two stages in the BILL MFA process.

  1. MFA setup: Add a valid phone number for setting up MFA in the organization (with POST /v3/mfa/setup), and then complete the setup by validating the entered phone number (with POST /v3/mfa/validate). At this point, the phone number is registered for the MFA sign in operation.
  2. MFA sign in: Generate an MFA challenge (with POST /v3/mfa/challenge), and then complete MFA sign in by validating the MFA challenge (with POST /v3/mfa/challenge/validate). At this point, your API session is MFA trusted.

Note: In the production environment, BILL requires an MFA-trusted API session for a set of API operations.

  • Enable vendor autoPay
  • Enable recurring bill autoPayment
  • Create a payment or bulk payment
  • Create a bank account in a BILL organization
  • Reset MFA (Complete MFA setup and MFA sign-in again)
post/v3/mfa/setup/validate

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Request body

setupIdstring required

MFA setupId from the POST /v3/mfa/setup response

type'VOICE' | 'TEXT' required

Phone type used for MFA setup

tokenstring required

Validation token sent to the registered phone number

Example request

{
  "setupId": "{{mfa_setup_id}}",
  "type": "TEXT",
  "token": "{{mfa_token}}"
}

Response

Validate phone for MFA setup response

status'SUCCESS' | 'FAILURE'

Request status