User

id

string

required

Required string length: 36

projectEnvironmentId

string

required

Required string length: 36

alias

string | null

Maximum length: 255

btcWallet

string | null

chain

enum<string>

Available options:

ETH,

EVM,

FLOW,

SOL,

ALGO,

STARK,

COSMOS,

BTC,

ECLIPSE

chainalysisChecks

object[]

Show child attributes

chainalysisChecks.createdAt

string

required

chainalysisChecks.id

string

required

Required string length: 36

chainalysisChecks.response

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

ckbWallet

string | null

country

string | null

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

Maximum length: 255

createdAt

string

discordNotification

boolean | null

dogeWallet

string | null

email

string | null

Maximum length: 255

emailNotification

boolean | null

firstName

string | null

Maximum length: 255

firstVisit

string

jobTitle

string | null

Maximum length: 255

kasWallet

string | null

kdaWallet

string | null

lastName

string | null

Maximum length: 255

lastVerifiedCredentialId

string

Required string length: 36

lastVisit

string

lists

string[]

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

ltcWallet

string | null

metadata

object

mfaBackupCodeAcknowledgement

enum<string> | null

Available options:

pending,

complete

mfaDevices

object[]

Show child attributes

mfaDevices.alias

string

The optional alias for the MFA device

mfaDevices.createdAt

string

The date and time the MFA device was created

mfaDevices.default

boolean

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

mfaDevices.id

string

Required string length: 36

mfaDevices.type

enum<string>

Available options:

totp,

passkey

mfaDevices.verified

boolean

Whether or not the user has a verified this MFA Device

mfaDevices.verifiedAt

string | null

The date and time the MFA device was verified

missingFields

object[]

Show child attributes

missingFields.enabled

boolean

required

missingFields.name

string

required

missingFields.required

boolean

required

missingFields.unique

boolean

required

missingFields.verify

boolean

required

missingFields.label

string

missingFields.position

number

missingFields.type

enum<string>

Available options:

standard,

custom

missingFields.validationRules

object

Optional validation rules for the custom field

Show child attributes

missingFields.validationRules.checkboxText

string

The text that will be displayed for the checkbox field

Maximum length: 255

missingFields.validationRules.regex

string

The regex pattern that the text field must match

Maximum length: 255

missingFields.validationRules.unique

boolean

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

missingFields.validationRules.validOptions

object[]

The dropdown options for the select field

Show child attributes

missingFields.validationRules.validOptions.label

string

required

Maximum length: 255

missingFields.validationRules.validOptions.key

string

Maximum length: 255

missingFields.validationType

enum<string>

Available options:

text,

checkbox,

select

newsletterNotification

boolean | null

newUser

boolean

oauthAccounts

object[]

Show child attributes

oauthAccounts.accountUsername

string

oauthAccounts.id

string

Required string length: 36

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,

dynamic,

alchemy,

zerodev,

telegram,

turnkey,

coinbaseWaas,

sms,

spotify,

tiktok,

line,

steam,

shopify

phoneNumber

string | null

Maximum length: 255

policiesConsent

boolean | null

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

sessionId

string

Required string length: 36

sessions

object[]

Show child attributes

sessions.createdAt

string

sessions.id

string

Required string length: 36

sessions.ipAddress

string

sessions.revokedAt

string | null

sessions.userAgent

string | null

team

string | null

Maximum length: 255

tShirtSize

string | null

Maximum length: 255

updatedAt

string

username

string | null

Maximum length: 255

verifiedCredentials

object[]

Show child attributes

verifiedCredentials.format

enum<string>

required

Available options:

blockchain,

email,

oauth,

passkey,

phoneNumber,

externalUser

verifiedCredentials.id

string

required

Required string length: 36

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

verifiedCredentials.chain

string

verifiedCredentials.email

string

verifiedCredentials.embedded_wallet_id

string | null

verifiedCredentials.isoCountryCode

string

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

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.

verifiedCredentials.name_service

object

Show child attributes

verifiedCredentials.name_service.avatar

string

verifiedCredentials.name_service.name

string

verifiedCredentials.oauth_account_id

string | null

verifiedCredentials.oauth_account_photos

string[]

verifiedCredentials.oauth_display_name

string | null

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.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,

dynamic,

alchemy,

zerodev,

telegram,

turnkey,

coinbaseWaas,

sms,

spotify,

tiktok,

line,

steam,

shopify

verifiedCredentials.oauth_username

string

verifiedCredentials.phoneCountryCode

string

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

verifiedCredentials.phoneNumber

string

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

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.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.refId

string

Required string length: 36

verifiedCredentials.signerRefId

string

Required string length: 36

verifiedCredentials.wallet_additional_addresses

object[]

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.wallet_name

string

verifiedCredentials.wallet_properties

object

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

Show child attributes

verifiedCredentials.wallet_properties.isAuthenticatorAttached

boolean

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

verifiedCredentials.wallet_properties.isSessionKeyCompatible

boolean

verifiedCredentials.wallet_properties.turnkeyHDWalletId

string

Required string length: 36

verifiedCredentials.wallet_properties.turnkeyPrivateKeyId

string

Required string length: 36

verifiedCredentials.wallet_properties.turnkeySubOrganizationId

string

Required string length: 36

verifiedCredentials.wallet_properties.turnkeyUserId

string

Required string length: 36

verifiedCredentials.wallet_properties.version

enum<string>

Available options:

V1,

V2

verifiedCredentials.wallet_provider

enum<string>

Available options:

browserExtension,

custodialService,

walletConnect,

qrCode,

deepLink,

embeddedWallet,

smartContractWallet

wallet

string

walletPublicKey

string

wallets

object[]

Show child attributes

wallets.chain

enum<string>

required

Available options:

ETH,

EVM,

FLOW,

SOL,

ALGO,

STARK,

COSMOS,

BTC,

ECLIPSE

wallets.id

string

required

Required string length: 36

wallets.name

string

required

wallets.provider

enum<string>

required

Available options:

browserExtension,

custodialService,

walletConnect,

qrCode,

deepLink,

embeddedWallet,

smartContractWallet

wallets.publicKey

string

required

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

Maximum length: 255

wallets.lastSelectedAt

string | null

wallets.properties

object

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

Show child attributes

wallets.properties.isAuthenticatorAttached

boolean

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

wallets.properties.isSessionKeyCompatible

boolean

wallets.properties.turnkeyHDWalletId

string

Required string length: 36

wallets.properties.turnkeyPrivateKeyId

string

Required string length: 36

wallets.properties.turnkeySubOrganizationId

string

Required string length: 36

wallets.properties.turnkeyUserId

string

Required string length: 36

wallets.properties.version

enum<string>

Available options:

V1,

V2