TypeScript Server SDK: partner-2fa
Public partner-2fa surface for @keyra/typescript-sdk.
On this page
Runtime: SERVER. See package overview for installation.
Enrollment
enable2FA()Starts enrollment and returns enrollmentUrl. The SDK also exposes qrCode as an alias of enrollmentUrl (URL string, not an image).get2FAStatus()Returns whether the partner user is enrolled for KEYRA Partner 2FA.pollEnrollment()Single poll of enrollment status. Prefer waitForEnrollment for the common loop.waitForEnrollment()Polls enrollment until completed or a terminal failure/timeout.
Authentication
pollChallenge()Single challenge poll. When status is approved, verificationToken is returned once — capture it immediately.startAuthentication()Creates an authentication challenge for an enrolled identity. Present challengeUrl (qrCode alias) to the user.waitForChallengeApproval()Polls until approved with verificationToken, or denied/expired/timeout. Returns the poll result including the one-shot token.