Start typing to search.

API Reference

Confirm TOTP re-enrollment

View Markdown

Verifies a TOTP code against the newly enrolled secret to activate it.

POST /api/users/me/totp/confirm

Verifies a TOTP code against the newly enrolled secret to activate it.

Operation ID: confirmTotpReEnroll

Authentication

Option 1

  • BearerAuth (http bearer) API key token. Create via POST /api/api-keys. Format: envoy_<hex>

Option 2

  • CookieAuth (apiKey) Session cookie set after login + TOTP verification

Request body

The request body is required.

application/json

  • Type: object
  • Properties:
    • code (string, required)

Success responses

200

TOTP re-enrollment confirmed

Content type: application/json

  • Type: object
  • Properties:
    • success (boolean)

Error responses

401

Invalid TOTP code

429

Too many requests

Content type: application/json

  • Reference: Error
    • Type: object
    • Properties:
      • error (string)
        • Example: NOT_FOUND
      • message (string)
        • Example: Resource not found

Example:

{
  "error": "RATE_LIMITED",
  "message": "Too many failed TOTP attempts. Try again later."
}

Examples

cURL

curl --request POST \
  --url 'https://your-envoy.example.com/api/users/me/totp/confirm' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "string"
}'

JavaScript (fetch)

const response = await fetch('https://your-envoy.example.com/api/users/me/totp/confirm', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "code": "string"
  }),
});
 
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);