getUserSettings
Get the current user’s settings including default currency and preferences.Parameters
No parameters required.Response
Returns the user’s settings object.string
User ID
string
Default currency code for the user
Date
Settings creation timestamp
Date
Last update timestamp
updateCurrency
Update the user’s default currency.Parameters
CurrencyCode
required
New default currency code (e.g., “USD”, “EUR”, “GBP”)
Response
Returns the updated user settings object.updateInfo
Update user profile information.Parameters
string
required
User’s display name (cannot be empty)
File | string
Profile image as a File object or URL string. If a File is provided, it will be uploaded to blob storage.
Response
boolean
Returns
true if the update was successfulupdatePassword
Change the user’s password.Parameters
string
required
Current password (cannot be empty)
string
required
New password (must meet password policy requirements)
The new password must meet the application’s password policy requirements.
Response
boolean
Returns
true if the password was changed successfullyverifyEmail
Send a verification email to the user’s email address.Parameters
No parameters required. Uses the authenticated user’s email.Response
boolean
Returns
true if the verification email was sent successfullylistAccounts
List all linked authentication accounts for the user.Parameters
No parameters required.Response
Returns an array of linked account objects.array
Array of linked account information
string
Authentication provider ID (e.g., “google”, “custom-oauth-provider”)
string
Account identifier with the provider
Date
When the account was linked
linkAccount
Link a new authentication provider to the user’s account.Parameters
enum
required
Provider to link:
google or custom-oauth-providerResponse
boolean
Returns
true if linking was initiated successfullystring
OAuth redirect URL for completing the linking process (if applicable)
After calling this endpoint, redirect the user to the provided
redirectUrl to complete the OAuth flow. They will be redirected back to the account settings page.unlinkAccount
Unlink an authentication provider from the user’s account.Parameters
enum
required
Provider to unlink:
google or custom-oauth-providerResponse
boolean
Returns
true if the account was unlinked successfullydeleteAccount
Permanently delete the user’s account and all associated data.Parameters
string
User’s password (required for accounts with email/password credentials)
Response
boolean
Returns
true if the account was deleted successfullyThe delete account feature must be enabled via feature flag. If disabled, users should contact support to delete their account.