Two-Factor Authentication

Setup Phone 2Fa

Set up phone number for 2FA during login.

Called when user doesn't have a phone number on file. Stores the phone and immediately sends verification SMS.

post/api/v1/auth/2fa/setup-phone

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/setup-phone
  • Auth: none declared

Request body

cognito_id_tokenstring required
cognito_access_tokenstring required
phone_numberstring required
device_fingerprintstring nullable

Response

Successful Response

successboolean required
requires_2faboolean
session_tokenstring nullable
phone_maskedstring nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.