Prove possession and reveal recovery codes once

POST

/v1/auth/totp/activate

curl --request POST \
  --url https://example.com/v1/auth/totp/activate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example", "mfa_token": "example" }'

• this engine

Activates the pending factor after verifying its code and reveals ten recovery codes once. A policy-forced enrolment also returns the completed login session.

Authorizations

• bearerAuth
• browserSession
• None

Request Body ^required

Media type application/json

object

code

required

string

mfa_token

string

Example ^generated

{
  "code": "example",
  "mfa_token": "example"
}

Responses

200

OK

Media type application/json

object

csrf_token

string

expires_at

string format: date-time

recovery_codes

required

Single-use recovery codes, revealed only in this response.

Array<string>

session_id

string format: uuid

token

string

Example ^generated

{
  "csrf_token": "example",
  "expires_at": "2026-04-15T12:00:00Z",
  "recovery_codes": [
    "example"
  ],
  "session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "token": "example"
}

400

Request refused

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Request refused

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Request refused

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Request refused

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Request refused

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Request refused

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

503

Request refused

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}