Two-Factor Authentication

Initiate 2Fa

Initiate 2FA after successful password authentication.

Process:

  1. Verify Cognito tokens
  2. Check if device is trusted
  3. If trusted, return tokens immediately
  4. If not trusted, send SMS and return session token
post/api/v1/auth/2fa/initiate

Request

  • Base URL: https://app.perlucem.ai (the document declares no server; this is the origin it was published from)
  • URL: https://app.perlucem.ai/api/v1/auth/2fa/initiate
  • Auth: none declared

Request body

cognito_id_tokenstring required
cognito_access_tokenstring required
device_fingerprintstring nullable

Response

Successful Response

requires_2faboolean required
requires_phone_setupboolean
session_tokenstring nullable
phone_maskedstring nullable
trusted_deviceboolean
id_tokenstring nullable
access_tokenstring nullable
errorstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.