Start step-up authentication

POST

/auth/step-up/start

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/auth/step-up/start \
  --header 'Content-Type: application/json' \
  --data '{ "step_up_token": "stu_...", "preferred_method": { "category": "otp", "method": "email_otp" } }'

Start a step-up action from a step_up_token and optional preferred method.

Request Body ^required

Start a step-up action from a step-up token.

Media type application/json

object

step_up_token

required

string

preferred_method

object

category

string

method

string

Example

{
  "step_up_token": "stu_...",
  "preferred_method": {
    "category": "otp",
    "method": "email_otp"
  }
}

Responses

200

Step-up start result.

Media type application/json

object

action_id

string

status

string

preferred_method

object

category

string

method

string

expires_at

string

expires_at_unix

integer format: int64

next_action

string

Example

{
  "action_id": "step_123",
  "status": "pending",
  "preferred_method": {
    "category": "otp",
    "method": "email_otp"
  },
  "expires_at": "2026-02-01T00:05:00.000Z",
  "expires_at_unix": 1770000300,
  "next_action": "verify_code"
}

default

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}