v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

mfa

MFA step-up for API session

Set your current API session as MFA trusted.

Ideally, when you sign in with POST /v3/login, set rememberMeId and device in your request to generate an MFA-trusted API session.

In case you sign in without rememberMeId and device in your request, you can use this POST /v3/mfa/step-up endpoint to mark the current API session as MFA trusted.

post/v3/mfa/step-up

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

rememberMeIdstring

MFA ID. Set this field for creating an MFA-trusted API session.

This MFA ID is generated when you set rememberMe as true in your POST /v3/mfa/challenge/validate request. This value expires in 30 days.

See Validate MFA challenge for more information.

devicestring

Mobile device name. This is a nickname for your mobile device. Set this field when you set rememberMeId.

Example request

{
  "rememberMeId": "{{mfa_remember_me_id}}",
  "device": "{{mfa_device_name}}"
}

Response

MFA step-up for API session response

trustedboolean

This field is set as true if the current API session is MFA-trusted