Complete step-up authentication

POST

/auth/step-up/actions/{actionId}/complete

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/auth/step-up/actions/example/complete \
  --header 'Content-Type: application/json' \
  --data '{ "method": "email_otp", "input": { "code": "123456" } }'

Submit method-specific input to complete a step-up action. Requires Idempotency-Key.

Parameters

Path Parameters

actionId

required

string

Request Body ^required

Complete a step-up action.

Media type application/json

object

method

required

string

input

required

object

key

additional properties

Example

{
  "method": "email_otp",
  "input": {
    "code": "123456"
  }
}

Responses

200

Step-up completion result.

Media type application/json

object

action_id

string

status

string

receipt

object

receipt_id

string

expires_at

integer format: int64

Example

{
  "action_id": "step_123",
  "status": "completed",
  "receipt": {
    "receipt_id": "sur_123",
    "expires_at": 1770000600000
  }
}

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"
}