User

id

string

required

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

projectEnvironmentId

string

required

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

verifiedCredentials

object[]

Show child attributes

verifiedCredentials.id

string

required

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

verifiedCredentials.format

enum<string>

required

Available options:

blockchain,

email,

oauth,

passkey,

phoneNumber,

externalUser

verifiedCredentials.signInEnabled

boolean

required

This indicates if the user can sign in with this credential

verifiedCredentials.address

string

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

Maximum length: 255

Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

verifiedCredentials.chain

string

verifiedCredentials.refId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

verifiedCredentials.signerRefId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

verifiedCredentials.email

string

verifiedCredentials.name_service

object

Show child attributes

verifiedCredentials.name_service.avatar

string

verifiedCredentials.name_service.name

string

verifiedCredentials.public_identifier

string

This is used to publicly identify a verified credential in a human-friendly way. For example, this will be the email address if credential format=email.

verifiedCredentials.wallet_name

string

verifiedCredentials.wallet_provider

enum<string>

Available options:

browserExtension,

custodialService,

walletConnect,

qrCode,

deepLink,

embeddedWallet,

smartContractWallet

verifiedCredentials.wallet_properties

object

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5

Show child attributes

verifiedCredentials.wallet_properties.turnkeySubOrganizationId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

verifiedCredentials.wallet_properties.turnkeyPrivateKeyId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

verifiedCredentials.wallet_properties.turnkeyHDWalletId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

verifiedCredentials.wallet_properties.isAuthenticatorAttached

boolean

Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.

verifiedCredentials.wallet_properties.turnkeyUserId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

verifiedCredentials.wallet_properties.isSessionKeyCompatible

boolean

verifiedCredentials.wallet_properties.version

enum<string>

Available options:

V1,

V2,

V3

verifiedCredentials.wallet_properties.ecdsaProviderType

enum<string>

Available options:

zerodev_signer_to_ecdsa,

zerodev_multi_chain

verifiedCredentials.wallet_properties.entryPointVersion

enum<string>

Available options:

v6,

v7

verifiedCredentials.wallet_properties.kernelVersion

enum<string>

Available options:

v2_4,

v3_0,

v3_1

verifiedCredentials.oauth_provider

enum<string>

Available options:

emailOnly,

magicLink,

apple,

bitbucket,

coinbasesocial,

discord,

epicgames,

facebook,

farcaster,

github,

gitlab,

google,

instagram,

linkedin,

microsoft,

twitch,

twitter,

blocto,

banxa,

coinbaseOnramp,

dynamic,

alchemy,

zerodev,

telegram,

turnkey,

coinbaseWaas,

sms,

spotify,

tiktok,

line,

steam,

shopify

verifiedCredentials.oauth_username

string

verifiedCredentials.oauth_display_name

string | null

verifiedCredentials.oauth_account_id

string | null

verifiedCredentials.phoneNumber

string

This field contains the phone number in the country. This could also contain the area code within a country.

Example:

"9171113333"

verifiedCredentials.phoneCountryCode

string

This field contains the phone international country code. See https://countrycode.org/

Example:

"1"

verifiedCredentials.isoCountryCode

string

ISO-3166 two-character country code. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

Example:

"US"

verifiedCredentials.oauth_account_photos

string[]

verifiedCredentials.oauth_emails

string[]

verifiedCredentials.oauth_metadata

object

This object contains JSON metadata for a social-based verified credential. It may contain data about the user that does not fit into the other structured fields, and could include arbitrary fields about the user from the oauth provider's API.

verifiedCredentials.previous_users

string[]

This will only be provided in the responses for GET /users/{userId}.Previous user IDs that owned this verified credential and was tranfered to the current user ID.

verifiedCredentials.embedded_wallet_id

string | null

verifiedCredentials.wallet_additional_addresses

object[]

An additional address associated with a wallet.

Show child attributes

verifiedCredentials.wallet_additional_addresses.address

string

required

An address associated with a wallet.

verifiedCredentials.wallet_additional_addresses.type

enum<string>

required

Available options:

ordinals,

payment,

cosmos,

evm

verifiedCredentials.wallet_additional_addresses.publicKey

string

The public key associated with the address.

verifiedCredentials.lastSelectedAt

string

This timestamp indicates the last time this verified wallet was either connected to the user account or selected to become the primary wallet on the account.

lastVerifiedCredentialId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

sessionId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

alias

string | null

Maximum length: 255

Example:

"An example name"

country

string | null

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

Maximum length: 255

Example:

"US"

email

string | null

Maximum length: 255

firstName

string | null

Maximum length: 255

Example:

"An example name"

jobTitle

string | null

Maximum length: 255

Example:

"An example name"

lastName

string | null

Maximum length: 255

Example:

"An example name"

phoneNumber

string | null

Maximum length: 255

policiesConsent

boolean | null

tShirtSize

string | null

Maximum length: 255

Example:

"An example name"

team

string | null

Maximum length: 255

Example:

"An example name"

username

string | null

Maximum length: 255

Example:

"An example name"

firstVisit

string

lastVisit

string

newUser

boolean

metadata

object

mfaBackupCodeAcknowledgement

enum<string> | null

Available options:

pending,

complete

btcWallet

string | null

kdaWallet

string | null

ltcWallet

string | null

ckbWallet

string | null

kasWallet

string | null

dogeWallet

string | null

emailNotification

boolean | null

discordNotification

boolean | null

newsletterNotification

boolean | null

lists

string[]

Access lists evaluated by Dynamic when considering access for the user.

scope

string

A whitespace-separate list of permissions associated with the JWT token issued. This conforms to the JWT standard for scope claims: https://datatracker.ietf.org/doc/html/rfc8693#section-4.2

Example:

"superuser marketing operations"

missingFields

object[]

Show child attributes

missingFields.name

string

required

missingFields.required

boolean

required

missingFields.enabled

boolean

required

missingFields.unique

boolean

required

missingFields.verify

boolean

required

missingFields.type

enum<string>

Available options:

standard,

custom

missingFields.validationRules

object

Optional validation rules for the custom field

Show child attributes

missingFields.validationRules.unique

boolean

If this field must be unique for every user in the environment

missingFields.validationRules.regex

string

The regex pattern that the text field must match

Maximum length: 255

Example:

"^0x"

missingFields.validationRules.validOptions

object[]

The dropdown options for the select field

Show child attributes

missingFields.validationRules.validOptions.label

string

required

Maximum length: 255

Example:

"An example name"

missingFields.validationRules.validOptions.key

string

Maximum length: 255

Example:

"An example name"

Example:

[
  { "label": "small" },
  { "label": "medium" },
  { "label": "large" }
]

missingFields.validationRules.checkboxText

string

The text that will be displayed for the checkbox field

Maximum length: 255

Example:

"Agree to the terms and conditions"

missingFields.validationType

enum<string>

Available options:

text,

checkbox,

select

missingFields.label

string

missingFields.position

number

walletPublicKey

string

wallet

string

chain

enum<string>

Available options:

ETH,

EVM,

FLOW,

SOL,

ALGO,

STARK,

COSMOS,

BTC,

ECLIPSE

createdAt

string

updatedAt

string

sessions

object[]

Show child attributes

sessions.id

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

sessions.createdAt

string

sessions.ipAddress

string

sessions.userAgent

string | null

sessions.revokedAt

string | null

wallets

object[]

Show child attributes

wallets.id

string

required

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

wallets.name

string

required

Example:

"An example name"

wallets.chain

enum<string>

required

Available options:

ETH,

EVM,

FLOW,

SOL,

ALGO,

STARK,

COSMOS,

BTC,

ECLIPSE

wallets.publicKey

string

required

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

Maximum length: 255

Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

wallets.provider

enum<string>

required

Available options:

browserExtension,

custodialService,

walletConnect,

qrCode,

deepLink,

embeddedWallet,

smartContractWallet

wallets.properties

object

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5

Show child attributes

wallets.properties.turnkeySubOrganizationId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

wallets.properties.turnkeyPrivateKeyId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

wallets.properties.turnkeyHDWalletId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

wallets.properties.isAuthenticatorAttached

boolean

Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.

wallets.properties.turnkeyUserId

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

wallets.properties.isSessionKeyCompatible

boolean

wallets.properties.version

enum<string>

Available options:

V1,

V2,

V3

wallets.properties.ecdsaProviderType

enum<string>

Available options:

zerodev_signer_to_ecdsa,

zerodev_multi_chain

wallets.properties.entryPointVersion

enum<string>

Available options:

v6,

v7

wallets.properties.kernelVersion

enum<string>

Available options:

v2_4,

v3_0,

v3_1

wallets.lastSelectedAt

string | null

chainalysisChecks

object[]

Show child attributes

chainalysisChecks.id

string

required

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

chainalysisChecks.createdAt

string

required

chainalysisChecks.result

enum<string>

required

Available options:

OK,

BLOCKED,

FAILED

chainalysisChecks.walletPublicKey

string

required

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

Maximum length: 255

Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

chainalysisChecks.response

string

required

oauthAccounts

object[]

Show child attributes

oauthAccounts.id

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

oauthAccounts.provider

enum<string>

Available options:

emailOnly,

magicLink,

apple,

bitbucket,

coinbasesocial,

discord,

epicgames,

facebook,

farcaster,

github,

gitlab,

google,

instagram,

linkedin,

microsoft,

twitch,

twitter,

blocto,

banxa,

coinbaseOnramp,

dynamic,

alchemy,

zerodev,

telegram,

turnkey,

coinbaseWaas,

sms,

spotify,

tiktok,

line,

steam,

shopify

oauthAccounts.accountUsername

string

mfaDevices

object[]

Show child attributes

mfaDevices.type

enum<string>

Available options:

totp,

passkey

mfaDevices.verified

boolean

Whether or not the user has a verified this MFA Device

mfaDevices.id

string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

mfaDevices.createdAt

string

The date and time the MFA device was created

mfaDevices.verifiedAt

string | null

The date and time the MFA device was verified

mfaDevices.default

boolean

Whether or not this is the default MFA device for the user

mfaDevices.alias

string

The optional alias for the MFA device