Class: AuthService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:61

Extends

• BaseService

Constructors

Constructor

new AuthService(client): AuthService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:12

Parameters

client

TanqoryClient

Returns

AuthService

Inherited from

BaseService.constructor

Properties

client

protected client: TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:10

Inherited from

BaseService.client

Methods

addPhone()

addPhone(phoneNumber): Promise<{ expiresIn?: number; message: string; verificationSent?: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:608

Add phone number to account

Parameters

phoneNumber

string

Returns

Promise<{ expiresIn?: number; message: string; verificationSent?: boolean; }>

---

addSecondaryEmail()

addSecondaryEmail(email): Promise<{ email: string; message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:486

Add secondary email

Parameters

email

string

Returns

Promise<{ email: string; message: string; }>

---

buildQuery()

protected buildQuery(options?): Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:26

Build query parameters

Parameters

options?

ListOptions

Returns

Record<string, any>

Inherited from

BaseService.buildQuery

---

bulkRevokeSessions()

bulkRevokeSessions(sessionIds): Promise<{ count: number; message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:301

Bulk revoke sessions

Parameters

sessionIds

string[]

Returns

Promise<{ count: number; message: string; }>

---

cancelAccountDeletion()

cancelAccountDeletion(cancellationNote?): Promise<{ cancelledAt: Date; id: string; message: string; requestedAt: Date; scheduledAt: Date; status: "PENDING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:708

Cancel pending account deletion

Parameters

cancellationNote?

string

Optional note explaining why cancelled

Returns

Promise<{ cancelledAt: Date; id: string; message: string; requestedAt: Date; scheduledAt: Date; status: "PENDING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED"; }>

---

cancelEmailChange()

cancelEmailChange(): Promise<{ message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:573

Cancel pending email change

Returns

Promise<{ message: string; }>

---

changePassword()

changePassword(currentPassword, newPassword): Promise<{ message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:236

Change password

Parameters

currentPassword

string

newPassword

string

Returns

Promise<{ message: string; }>

---

checkEmail()

checkEmail(email): Promise<{ exists: boolean; user?: { email: string; hasAvatar?: boolean; name: string; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:69

Check if email exists

Parameters

email

string

Returns

Promise<{ exists: boolean; user?: { email: string; hasAvatar?: boolean; name: string; }; }>

---

checkHasPassword()

checkHasPassword(): Promise<{ hasPassword: boolean; socialAccountsCount: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:475

Check if user has password

Returns

Promise<{ hasPassword: boolean; socialAccountsCount: number; }>

---

confirmIdentity()

confirmIdentity(code, method): Promise<{ confirmationToken: string; expiresIn: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:533

Verify identity confirmation code and get confirmation token

Parameters

code

string

method

"TOTP" | "SMS" | "EMAIL"

Returns

Promise<{ confirmationToken: string; expiresIn: number; }>

---

connectSocialAccount()

connectSocialAccount(provider, redirectTo?): Promise<{ redirectUrl: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:452

Connect social account

Parameters

provider

"google" | "facebook" | "apple"

redirectTo?

string = '/account/security'

Returns

Promise<{ redirectUrl: string; }>

---

disableMfa()

disableMfa(type, verificationCode?, backupCode?): Promise<{ message: string; mfaEnabled: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:428

Disable MFA

Parameters

type

"TOTP" | "SMS"

verificationCode?

string

backupCode?

string

Returns

Promise<{ message: string; mfaEnabled: boolean; }>

---

disconnectSocialAccount()

disconnectSocialAccount(provider): Promise<{ message: string; success: true; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:466

Disconnect social account

Parameters

provider

"google" | "facebook" | "apple"

Returns

Promise<{ message: string; success: true; }>

---

exchangeToken()

exchangeToken(accessToken): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:155

Exchange access token for refresh-token cookie at the calling origin.

Used after SSO/OAuth callbacks where the access token arrives in the URL fragment but the refresh-token cookie is scoped to the issuer's origin. Calling this on the consumer origin (e.g. store.tanqory.com after admin issues the token) sets the httpOnly refresh_token cookie locally so silent refresh works on subsequent expiry.

Pass the access token explicitly via Authorization header — tokens may not yet be persisted to TokenManager at this point in the flow.

Parameters

accessToken

string

Returns

Promise<void>

---

exportActivityLogs()

exportActivityLogs(query?): Promise<string>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:746

Export activity logs as CSV Returns CSV content as string for download

Parameters

query?

Partial<ExportActivityLogQuery>

Optional query parameters for filtering export

Returns

Promise<string>

---

forgotPassword()

forgotPassword(email): Promise<{ message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:216

Request password reset

Parameters

email

string

Returns

Promise<{ message: string; }>

---

generateIdempotencyKey()

protected generateIdempotencyKey(prefix): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:19

Generate idempotency key

Parameters

prefix

string

Returns

string

Inherited from

BaseService.generateIdempotencyKey

---

getActivityLogs()

getActivityLogs(query?): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:735

Get activity logs with pagination and filtering

Parameters

query?

Partial<ActivityLogQuery>

Optional query parameters for filtering and pagination

Returns

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

---

getConnectedSocialAccounts()

getConnectedSocialAccounts(): Promise<{ accounts: object[]; hasPassword: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:445

Get connected social accounts

Returns

Promise<{ accounts: object[]; hasPassword: boolean; }>

---

getCurrentUser()

getCurrentUser(): Promise<{ avatar: string; createdAt: Date; email: string; emailVerified: boolean; emailVerifiedAt: Date; firstName: string; id: string; languageFeedback: boolean; lastLoginAt: Date; lastName: string; locale: string; mfaEnabled?: boolean; name: string; pendingEmail: string; phoneNumber: string; phoneVerified: boolean; region: string; secondaryEmail: string; secondaryEmailVerified: boolean; timezone: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:257

Get current user profile

Returns

Promise<{ avatar: string; createdAt: Date; email: string; emailVerified: boolean; emailVerifiedAt: Date; firstName: string; id: string; languageFeedback: boolean; lastLoginAt: Date; lastName: string; locale: string; mfaEnabled?: boolean; name: string; pendingEmail: string; phoneNumber: string; phoneVerified: boolean; region: string; secondaryEmail: string; secondaryEmailVerified: boolean; timezone: string; updatedAt: Date; }>

---

getExportMimeType()

protected getExportMimeType(format): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:45

Get MIME type for export format

Parameters

format

string

Returns

string

Inherited from

BaseService.getExportMimeType

---

getExportStatus()

getExportStatus(exportId): Promise<{ completedAt: Date; downloadUrl: string; expiresAt: Date; fileSize: number; format: "JSON" | "CSV" | "PDF"; id: string; message?: string; requestedAt: Date; status: "PENDING" | "EXPIRED" | "PROCESSING" | "COMPLETED" | "FAILED"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:682

Get data export status

Parameters

exportId

string

ID of the export request

Returns

Promise<{ completedAt: Date; downloadUrl: string; expiresAt: Date; fileSize: number; format: "JSON" | "CSV" | "PDF"; id: string; message?: string; requestedAt: Date; status: "PENDING" | "EXPIRED" | "PROCESSING" | "COMPLETED" | "FAILED"; }>

---

getMfaStatus()

getMfaStatus(): Promise<{ backupCodesRemaining: number; enabled: boolean; methods: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:414

Get MFA status

Returns

Promise<{ backupCodesRemaining: number; enabled: boolean; methods: object[]; }>

---

getSessions()

getSessions(): Promise<SessionData[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:286

Get all sessions (legacy - for backward compatibility)

Returns

Promise<SessionData[]>

---

getSessionsPaginated()

getSessionsPaginated(query?): Promise<{ data: object[]; pagination: { hasMore: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:277

Get sessions with pagination

Parameters

query?

active?

boolean

deviceType?

"all" | "mobile" | "desktop" | "tablet"

limit

number

offset?

number

page

number

search?

string

sortBy

"createdAt" | "lastAccessedAt"

sortOrder

"asc" | "desc"

status?

"all" | "active" | "expired"

Returns

Promise<{ data: object[]; pagination: { hasMore: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

---

initiateMfaRecovery()

initiateMfaRecovery(email): Promise<{ message: string; recoveryTokenSent?: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:584

Initiate MFA recovery (sends recovery email)

Parameters

email

string

Returns

Promise<{ message: string; recoveryTokenSent?: boolean; }>

---

login()

login(email, password): Promise<{ accessToken?: string; expiresIn?: number; mfaRequired?: boolean; mfaTypes?: ("TOTP" | "SMS" | "EMAIL")[]; refreshToken?: string; tempToken?: string; user: { avatar: string; email: string; emailVerified?: boolean; firstName?: string; id: string; lastName?: string; name: string; }; } | { mfaRequired: true; mfaTypes: ("TOTP" | "SMS" | "EMAIL")[]; tempToken: string; user: { avatar: string; email: string; id: string; name: string; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:89

Login user

Parameters

email

string

password

string

Returns

Promise<{ accessToken?: string; expiresIn?: number; mfaRequired?: boolean; mfaTypes?: ("TOTP" | "SMS" | "EMAIL")[]; refreshToken?: string; tempToken?: string; user: { avatar: string; email: string; emailVerified?: boolean; firstName?: string; id: string; lastName?: string; name: string; }; } | { mfaRequired: true; mfaTypes: ("TOTP" | "SMS" | "EMAIL")[]; tempToken: string; user: { avatar: string; email: string; id: string; name: string; }; }>

---

logout()

logout(): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:138

Logout user

Returns

Promise<void>

---

nativeLogin()

nativeLogin(provider, idToken): Promise<{ accessToken?: string; expiresIn?: number; mfaRequired?: boolean; mfaTypes?: ("TOTP" | "SMS" | "EMAIL")[]; refreshToken?: string; tempToken?: string; user: { avatar: string; email: string; emailVerified?: boolean; firstName?: string; id: string; lastName?: string; name: string; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:118

Native mobile login (Google/Apple ID token exchange) API: POST /auth/native/:provider

Parameters

provider

string

'google' | 'apple'

idToken

string

Native ID token from Google/Apple Sign-In

Returns

Promise<{ accessToken?: string; expiresIn?: number; mfaRequired?: boolean; mfaTypes?: ("TOTP" | "SMS" | "EMAIL")[]; refreshToken?: string; tempToken?: string; user: { avatar: string; email: string; emailVerified?: boolean; firstName?: string; id: string; lastName?: string; name: string; }; }>

---

refresh()

refresh(refreshToken?): Promise<{ accessToken: string; expiresIn: number; refreshToken: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:165

Refresh access token

Parameters

refreshToken?

string

Returns

Promise<{ accessToken: string; expiresIn: number; refreshToken: string; }>

---

regenerateBackupCodes()

regenerateBackupCodes(): Promise<{ backupCodes: string[]; warning: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:403

Regenerate backup codes

Returns

Promise<{ backupCodes: string[]; warning: string; }>

---

register()

register(data): Promise<{ message: string; user: { avatar: string; email: string; emailVerified?: boolean; firstName: string; id: string; lastName: string; name: string; }; verificationToken?: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:79

Register a new user

Parameters

data

acceptTerms

boolean

email

string

firstName

string

lastName

string

marketingEmails?

boolean

password

string

Returns

Promise<{ message: string; user: { avatar: string; email: string; emailVerified?: boolean; firstName: string; id: string; lastName: string; name: string; }; verificationToken?: string; }>

---

removeAvatar()

removeAvatar(): Promise<{ message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:660

Remove avatar from account

Returns

Promise<{ message: string; }>

---

removePhone()

removePhone(): Promise<{ message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:633

Remove phone number from account

Returns

Promise<{ message: string; }>

---

removeSecondaryEmail()

removeSecondaryEmail(): Promise<{ message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:511

Remove secondary email

Returns

Promise<{ message: string; }>

---

requestAccountDeletion()

requestAccountDeletion(password, reason?): Promise<{ cancelledAt: Date; id: string; message: string; requestedAt: Date; scheduledAt: Date; status: "PENDING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:695

Request account deletion

Parameters

password

string

Current password for verification

reason?

string

Optional reason for deletion

Returns

Promise<{ cancelledAt: Date; id: string; message: string; requestedAt: Date; scheduledAt: Date; status: "PENDING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED"; }>

---

requestDataExport()

requestDataExport(format?): Promise<{ completedAt: Date; downloadUrl: string; expiresAt: Date; fileSize: number; format: "JSON" | "CSV" | "PDF"; id: string; message?: string; requestedAt: Date; status: "PENDING" | "EXPIRED" | "PROCESSING" | "COMPLETED" | "FAILED"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:672

Request data export (GDPR compliance)

Parameters

format?

"JSON" | "CSV"

Export format ('JSON' | 'CSV')

Returns

Promise<{ completedAt: Date; downloadUrl: string; expiresAt: Date; fileSize: number; format: "JSON" | "CSV" | "PDF"; id: string; message?: string; requestedAt: Date; status: "PENDING" | "EXPIRED" | "PROCESSING" | "COMPLETED" | "FAILED"; }>

---

requestEmailChange()

requestEmailChange(newEmail, confirmationToken): Promise<{ message: string; pendingEmail: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:545

Request email change (requires confirmation token)

Parameters

newEmail

string

confirmationToken

string

Returns

Promise<{ message: string; pendingEmail: string; }>

---

requestSmsDisable()

requestSmsDisable(): Promise<{ expiresIn: number; maskedPhone: string; message: string; success: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:421

Request SMS verification code for disable

Returns

Promise<{ expiresIn: number; maskedPhone: string; message: string; success: boolean; }>

---

resendEmailChangeVerification()

resendEmailChangeVerification(): Promise<{ message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:566

Resend email change verification email

Returns

Promise<{ message: string; }>

---

resendMfaSms()

resendMfaSms(tempToken): Promise<{ message: string; success: true; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:379

Resend SMS code during login

Parameters

tempToken

string

Returns

Promise<{ message: string; success: true; }>

---

resendPhoneVerification()

resendPhoneVerification(): Promise<{ expiresIn?: number; message: string; verificationSent?: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:626

Resend phone verification SMS

Returns

Promise<{ expiresIn?: number; message: string; verificationSent?: boolean; }>

---

resendSecondaryEmailVerification()

resendSecondaryEmailVerification(): Promise<{ message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:504

Resend secondary email verification

Returns

Promise<{ message: string; }>

---

resendVerification()

resendVerification(email): Promise<{ message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:202

Resend verification email

Parameters

email

string

Returns

Promise<{ message: string; }>

---

resetPassword()

resetPassword(token, password): Promise<{ message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:226

Reset password with token

Parameters

token

string

password

string

Returns

Promise<{ message: string; }>

---

revokeAllOtherSessions()

revokeAllOtherSessions(): Promise<{ count: number; message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:310

Revoke all other sessions

Returns

Promise<{ count: number; message: string; }>

---

revokeSession()

revokeSession(sessionId): Promise<{ message: string; success: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:294

Revoke a session

Parameters

sessionId

string

Returns

Promise<{ message: string; success: boolean; }>

---

sendIdentityConfirmationCode()

sendIdentityConfirmationCode(): Promise<{ maskedPhone?: string; message: string; method: "TOTP" | "SMS" | "EMAIL"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:522

Send identity confirmation code (TOTP / SMS / Email OTP)

Returns

Promise<{ maskedPhone?: string; message: string; method: "TOTP" | "SMS" | "EMAIL"; }>

---

setupSms()

setupSms(phoneNumber): Promise<{ expiresAt: string; maskedPhone: string; setupToken: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:351

Setup SMS MFA

Parameters

phoneNumber

string

Returns

Promise<{ expiresAt: string; maskedPhone: string; setupToken: string; }>

---

setupTotp()

setupTotp(): Promise<{ expiresAt: string; qrCodeUrl: string; secret: string; setupToken: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:321

Setup TOTP

Returns

Promise<{ expiresAt: string; qrCodeUrl: string; secret: string; setupToken: string; }>

---

updatePreferences()

updatePreferences(preferences): Promise<{ avatar: string; createdAt: Date; email: string; emailVerified: boolean; emailVerifiedAt: Date; firstName: string; id: string; languageFeedback: boolean; lastLoginAt: Date; lastName: string; locale: string; mfaEnabled?: boolean; name: string; pendingEmail: string; phoneNumber: string; phoneVerified: boolean; region: string; secondaryEmail: string; secondaryEmailVerified: boolean; timezone: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:721

Update user preferences (locale, timezone, region)

Parameters

preferences

languageFeedback?

boolean

locale?

string

region?

string

timezone?

string

Returns

Promise<{ avatar: string; createdAt: Date; email: string; emailVerified: boolean; emailVerifiedAt: Date; firstName: string; id: string; languageFeedback: boolean; lastLoginAt: Date; lastName: string; locale: string; mfaEnabled?: boolean; name: string; pendingEmail: string; phoneNumber: string; phoneVerified: boolean; region: string; secondaryEmail: string; secondaryEmailVerified: boolean; timezone: string; updatedAt: Date; }>

---

updateProfile()

updateProfile(data): Promise<{ avatar: string; createdAt: Date; email: string; emailVerified: boolean; emailVerifiedAt: Date; firstName: string; id: string; languageFeedback: boolean; lastLoginAt: Date; lastName: string; locale: string; mfaEnabled?: boolean; name: string; pendingEmail: string; phoneNumber: string; phoneVerified: boolean; region: string; secondaryEmail: string; secondaryEmailVerified: boolean; timezone: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:264

Update user profile

Parameters

data

avatar?

string

bio?

string

expectedUpdatedAt?

Date

firstName?

string

lastName?

string

phone?

string

Returns

Promise<{ avatar: string; createdAt: Date; email: string; emailVerified: boolean; emailVerifiedAt: Date; firstName: string; id: string; languageFeedback: boolean; lastLoginAt: Date; lastName: string; locale: string; mfaEnabled?: boolean; name: string; pendingEmail: string; phoneNumber: string; phoneVerified: boolean; region: string; secondaryEmail: string; secondaryEmailVerified: boolean; timezone: string; updatedAt: Date; }>

---

uploadAvatar()

uploadAvatar(file): Promise<{ avatar: string; message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:645

Upload avatar image

Parameters

file

File | Blob

File object or Blob to upload

Returns

Promise<{ avatar: string; message: string; }>

---

verifyBackupCode()

verifyBackupCode(code, tempToken): Promise<{ accessToken: string; expiresIn: number; refreshToken: string; remainingCodes: number; user: { avatar: string; email: string; emailVerified?: boolean; firstName?: string; id: string; lastName?: string; name: string; }; warning?: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:393

Verify backup code during login

Parameters

code

string

tempToken

string

Returns

Promise<{ accessToken: string; expiresIn: number; refreshToken: string; remainingCodes: number; user: { avatar: string; email: string; emailVerified?: boolean; firstName?: string; id: string; lastName?: string; name: string; }; warning?: string; }>

---

verifyEmail()

verifyEmail(token): Promise<{ message: string; user: { email: string; emailVerified: boolean; id: string; name: string; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:192

Verify email

Parameters

token

string

Returns

Promise<{ message: string; user: { email: string; emailVerified: boolean; id: string; name: string; }; }>

---

verifyEmailChange()

verifyEmailChange(token): Promise<{ message: string; newEmail: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:557

Verify email change with token from verification email

Parameters

token

string

Returns

Promise<{ message: string; newEmail: string; }>

---

verifyMfaRecovery()

verifyMfaRecovery(recoveryToken, code): Promise<{ backupCodes: string[]; message: string; success: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:594

Verify MFA recovery with token from email

Parameters

recoveryToken

string

code

string

Returns

Promise<{ backupCodes: string[]; message: string; success: boolean; }>

---

verifyPhone()

verifyPhone(code): Promise<{ expiresIn?: number; message: string; verificationSent?: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:617

Verify phone number with SMS code

Parameters

code

string

Returns

Promise<{ expiresIn?: number; message: string; verificationSent?: boolean; }>

---

verifySecondaryEmail()

verifySecondaryEmail(token): Promise<{ message: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:495

Verify secondary email

Parameters

token

string

Returns

Promise<{ message: string; }>

---

verifySmsLogin()

verifySmsLogin(code, tempToken): Promise<{ accessToken?: string; expiresIn?: number; mfaRequired?: boolean; mfaTypes?: ("TOTP" | "SMS" | "EMAIL")[]; refreshToken?: string; tempToken?: string; user: { avatar: string; email: string; emailVerified?: boolean; firstName?: string; id: string; lastName?: string; name: string; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:369

Verify SMS during login

Parameters

code

string

tempToken

string

Returns

Promise<{ accessToken?: string; expiresIn?: number; mfaRequired?: boolean; mfaTypes?: ("TOTP" | "SMS" | "EMAIL")[]; refreshToken?: string; tempToken?: string; user: { avatar: string; email: string; emailVerified?: boolean; firstName?: string; id: string; lastName?: string; name: string; }; }>

---

verifySmsSetup()

verifySmsSetup(code): Promise<{ backupCodes: string[]; success: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:360

Verify SMS setup

Parameters

code

string

Returns

Promise<{ backupCodes: string[]; success: boolean; }>

---

verifyTotpLogin()

verifyTotpLogin(code, tempToken): Promise<{ accessToken?: string; expiresIn?: number; mfaRequired?: boolean; mfaTypes?: ("TOTP" | "SMS" | "EMAIL")[]; refreshToken?: string; tempToken?: string; user: { avatar: string; email: string; emailVerified?: boolean; firstName?: string; id: string; lastName?: string; name: string; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:337

Verify TOTP during login

Parameters

code

string

tempToken

string

Returns

Promise<{ accessToken?: string; expiresIn?: number; mfaRequired?: boolean; mfaTypes?: ("TOTP" | "SMS" | "EMAIL")[]; refreshToken?: string; tempToken?: string; user: { avatar: string; email: string; emailVerified?: boolean; firstName?: string; id: string; lastName?: string; name: string; }; }>

---

verifyTotpSetup()

verifyTotpSetup(code): Promise<{ backupCodes: string[]; success: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/auth.ts:328

Verify TOTP setup

Parameters

code

string

Returns

Promise<{ backupCodes: string[]; success: boolean; }>