Skip to content

Initialize MFA Flow

GET
/mfa/flows/{flow}

Creates and returns a signed MFA token for a specific flow. The token contains challenges that need to be completed for the flow. Supported flows: phone_update_flow, payment_method_create_flow, payment_method_select_flow, payment_method_delete_flow

Flow:

  1. Authenticate user via JWT token (required).
  2. Validate flow name against supported MFA flows.
  3. Initialize all required challenges for the flow in pending status.
  4. Generate and sign MFA JWT token.
  5. Return the MFA token to the client.
flow
required
string
Allowed values: phone_update_flow payment_method_create_flow payment_method_select_flow payment_method_delete_flow

MFA Flow Name

OK

object
token
string
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Bad request - invalid flow name

object
error
string
some meaningful error message

Unauthorized - missing or invalid auth token

object
error
string
some meaningful error message

Internal server error

object
error
string
some meaningful error message