confirmAuthenticatorEnrollment

POST

/api/v1/me/security/totp/confirm

curl --request POST \
  --url https://example.com/api/v1/me/security/totp/confirm \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: example' \
  --data '{ "code": "example" }'

Confirm authenticator enrollment. Requires an enrolled dashboard session.

Parameters

Header Parameters

X-CSRF-Token

required

string

Request Body^required

Media typeapplication/json

object

code

required

The six-digit authenticator code.

string

Example^generated

{
  "code": "example"
}

Responses

200

Updated security state

Media typeapplication/json

object

data

required

object

relyingPartyId

required

string

userHandle

required

string

totpEnrolled

required

boolean

totpConfirmedAt

string format: date-time

passkeys

required

Array<object>

object

id

required

string format: uuid

name

required

string

credentialId

required

string

createdAt

required

string format: date-time

lastUsedAt

string format: date-time

recoveryCodesRemaining

required

integer

enrolled

required

boolean

passkeysAvailable

required

boolean

passkeysUnavailableReason

required

string

required

required

boolean

policy

required

string

Allowed values: none administrators all

authMethod

required

string

Allowed values: password totp passkey recovery_code demo

Example

{
  "data": {
    "policy": "none",
    "authMethod": "password"
  }
}

401

Incorrect code

404

No pending enrollment