InternalUserFields

User fields that can be updated on dashboard or through the rest API which do not involve any uniqueness checks or further verification

alias · string

Maximum string length: 255

Example:

"An example name"

firstName · string

Maximum string length: 255

Example:

"An example name"

lastName · string

Maximum string length: 255

Example:

"An example name"

jobTitle · string

Maximum string length: 255

Example:

"An example name"

phoneNumber · string

Maximum string length: 255

Example:

"An example name"

metadata · object

mfaBackupCodeAcknowledgement · enum<string> | null

Available options: pending, complete

tShirtSize · string

Maximum string length: 255

Example:

"An example name"

team · string

Maximum string length: 255

Example:

"An example name"

policiesConsent · boolean

country · string | null

Standard ISO 3166-1 alpha-2 two-letter country code

Maximum string length: 255

Example:

"US"

username · string | null

Alphanumeric with slugs and underscores username

Maximum string length: 255

Example:

"johndoe"

btcWallet · string | null

BTC wallet address

Example:

"3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5"

kdaWallet · string | null

KDA wallet address

Example:

"k:0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF"

ltcWallet · string | null

LTC wallet address

Example:

"LUttH43tQ4x4qniCKr1Rqo8ESeXFPdv9ax"

ckbWallet · string | null

CKB wallet address

Example:

"ckt1q9876543210abcdefghijklmnopqrstuvwxyz"

kasWallet · string | null

KAS wallet address

Example:

"kaspa:qrelgny7sr3vahq69yykxx36m65gvmhryxrlwngfzgu8xkdslum2yxjp3ap8m"

dogeWallet · string | null

DOGE wallet address

Example:

"DPcy35vmuk8GXcfu1vgFFEeij3BuYYJQKB"

emailNotification · boolean

discordNotification · boolean

newsletterNotification · boolean

emailVerifiedAt · string<date-time>

When provided, the user email will be marked as verified in our system and the user will be allowed to sign in with that email. When social is enabled and the social provider has a verified email, we will automatically associate that social with the existing user.

email · string

If email is trusted and verified, please provide a emailVerifiedAt timestamp. This will ensure that a user signing in with this email can access the correctly-created user account.

Maximum string length: 255

Example:

"[e-mail]"

wallets · object[]

Show child attributes

wallets. publicWalletAddress · string · required

Valid blockchain wallet address, must be an alphanumeric string without any special characters

Maximum string length: 255

Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

wallets. chain · enum<string> · required

Available options: ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC, ECLIPSE, SUI, SPARK, TRON, APTOS, TON

wallets. walletName · string · required

Maximum string length: 255

Example:

"An example name"

wallets. walletProvider · enum<string> · required

Available options: browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet

wallets. additionalWalletAddresses · object[]

Show child attributes

wallets.additionalWalletAddresses. address · string · required

An address associated with a wallet.

wallets.additionalWalletAddresses. type · enum<string> · required

Available options: ordinals, payment, cosmos, evm

wallets.additionalWalletAddresses. publicKey · string

The public key associated with the address.

oauthAccounts · object[]

Show child attributes

oauthAccounts. provider · enum<string> · required

The 'turnkey' value is deprecated and will be removed in a future version.

Available options: emailOnly, magicLink, apple, bitbucket, coinbasesocial, discord, epicgames, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, blocto, banxa, coinbaseOnramp, cryptoDotCom, dynamic, alchemy, zerodev, telegram, turnkey, coinbaseWaas, sms, spotify, tiktok, line, steam, shopify, zksync, kraken, blockaid, passkey, okta, sendgrid, resend

oauthAccounts. accountId · string · required

Maximum string length: 255

Example:

"An example name"

oauthAccounts. emails · string[]

Maximum string length: 255

oauthAccounts. displayName · string

Maximum string length: 255

Example:

"An example name"

oauthAccounts. username · string

Maximum string length: 255

Example:

"An example name"

oauthAccounts. photos · string[]

oauthAccounts. profile · object