Go to developer

SDKs / typescript / partner-2fa

startAuthentication()

SERVERmethod@keyra/typescript-sdk

Creates an authentication challenge for an enrolled identity. Present challengeUrl (qrCode alias) to the user.

Signature

TypeScript
await partner.startAuthentication(externalUserId, { nonce?, returnUrl? })

Type signature

TypeScript
startAuthentication(externalUserId: string, opts?: StartAuthOptions): Promise<ChallengeSession>

Parameters

ParameterTypeRequiredDescription
externalUserIdstringRequired
optsStartAuthOptionsOptionalDefault: {}

Returns

Promise<ChallengeSession>

SDK behavior

  • Maps challengeUrl → qrCode.

Underlying API