DynamicJwt

kid · string · required

aud · string · required

iss · string · required

sub · string · required

sid · string · required

environment_id · string · required

Required string length: 36

Example:

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

missing_fields · object[] · required

Show child attributes

missing_fields. name · string · required

missing_fields. required · boolean · required

missing_fields. enabled · boolean · required

missing_fields. unique · boolean · required

missing_fields. verify · boolean · required

missing_fields. type · enum<string>

Available options: standard, custom

missing_fields. validationRules · object

Optional validation rules for the custom field

Show child attributes

missing_fields.validationRules. unique · boolean

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

missing_fields.validationRules. regex · string

The regex pattern that the text field must match

Maximum string length: 255

Example:

"^0x"

missing_fields.validationRules. validOptions · object[]

The dropdown options for the select field

Show child attributes

missing_fields.validationRules.validOptions. label · string · required

Maximum string length: 255

Example:

"An example name"

missing_fields.validationRules.validOptions. key · string

Maximum string length: 255

Example:

"An example name"

Example:

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

missing_fields.validationRules. checkboxText · string

The text that will be displayed for the checkbox field

Maximum string length: 255

Example:

"Agree to the terms and conditions"

missing_fields. validationType · enum<string>

Available options: text, checkbox, select

missing_fields. label · string

missing_fields. position · number

verified_credentials · object[] · required

Show child attributes

verified_credentials. id · string · required

Required string length: 36

Example:

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

verified_credentials. format · enum<string> · required

Available options: blockchain, email, oauth, passkey, phoneNumber, externalUser

verified_credentials. signInEnabled · boolean · required

This indicates if the user can sign in with this credential

verified_credentials. address · string

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

Maximum string length: 255

Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

verified_credentials. chain · string

verified_credentials. refId · string

Required string length: 36

Example:

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

verified_credentials. signerRefId · string

Required string length: 36

Example:

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

verified_credentials. email · string<email>

verified_credentials. name_service · object

Show child attributes

verified_credentials.name_service. avatar · string

verified_credentials.name_service. name · string

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

verified_credentials. wallet_name · string

verified_credentials. wallet_provider · enum<string>

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

verified_credentials. wallet_properties · object · deprecated

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

verified_credentials.wallet_properties. turnkeySubOrganizationId · string · deprecated

Required string length: 36

Example:

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

verified_credentials.wallet_properties. turnkeyPrivateKeyId · string · deprecated

Required string length: 36

Example:

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

verified_credentials.wallet_properties. turnkeyHDWalletId · string · deprecated

Required string length: 36

Example:

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

verified_credentials.wallet_properties. isAuthenticatorAttached · boolean

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

verified_credentials.wallet_properties. turnkeyUserId · string · deprecated

Required string length: 36

Example:

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

verified_credentials.wallet_properties. isSessionKeyCompatible · boolean

verified_credentials.wallet_properties. version · enum<string>

Available options: V1, V2, V3

verified_credentials.wallet_properties. ecdsaProviderType · enum<string>

Available options: zerodev_signer_to_ecdsa, zerodev_multi_chain

verified_credentials.wallet_properties. entryPointVersion · enum<string>

Available options: v6, v7

verified_credentials.wallet_properties. kernelVersion · enum<string>

Available options: v2_4, v3_0, v3_1, v3_2, v3_3

verified_credentials. oauth_provider · enum<string>

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

verified_credentials. oauth_username · string

verified_credentials. oauth_display_name · string | null

verified_credentials. oauth_account_id · string | null

verified_credentials. phoneNumber · string

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

Example:

"9171113333"

verified_credentials. phoneCountryCode · string

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

Example:

"1"

verified_credentials. isoCountryCode · string

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

Example:

"US"

verified_credentials. oauth_account_photos · string[]

verified_credentials. oauth_emails · string[]

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

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

Required string length: 36

verified_credentials. embedded_wallet_id · string | null

verified_credentials. wallet_additional_addresses · object[]

Show child attributes

verified_credentials.wallet_additional_addresses. address · string · required

An address associated with a wallet.

verified_credentials.wallet_additional_addresses. type · enum<string> · required

Available options: ordinals, payment, cosmos, evm

verified_credentials.wallet_additional_addresses. publicKey · string

The public key associated with the address.

verified_credentials. lastSelectedAt · string<date-time>

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.

last_verified_credential_id · string · required

Required string length: 36

Example:

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

exp · number

iat · number

session_public_key · string

alias · string

blockchain_accounts · object[]

Show child attributes

blockchain_accounts. address · string · required

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

Maximum string length: 255

Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

blockchain_accounts. chain · string · required

blockchain_accounts. id · string · required

Required string length: 36

Example:

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

blockchain_accounts. wallet_name · string · required

blockchain_accounts. wallet_provider · enum<string> · required

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

blockchain_accounts. name_service · object

Show child attributes

blockchain_accounts.name_service. avatar · string

blockchain_accounts.name_service. name · string

country · string

email · string<email>

family_name · string

given_name · string

job_title · string

last_authenticated_account_id · string

Required string length: 36

Example:

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

lists · string[]

phone_number · string

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"

t_shirt_size · string

team · string

username · string

policies_consent · boolean

verified_account · object

Show child attributes

verified_account. address · string · required

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

Maximum string length: 255

Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

verified_account. chain · string · required

verified_account. id · string · required

Required string length: 36

Example:

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

verified_account. wallet_name · string · required

verified_account. wallet_provider · enum<string> · required

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

verified_account. name_service · object

Show child attributes

verified_account.name_service. avatar · string

verified_account.name_service. name · string

first_visit · string<date-time>

last_visit · string<date-time>

new_user · boolean

btc_wallet · string

kda_wallet · string

ltc_wallet · string

ckb_wallet · string

kas_wallet · string

doge_wallet · string

email_notification · boolean

discord_notification · boolean

newsletter_notification · boolean

metadata · object

verifiedCredentialsHashes · object

This contains the hashed string of the concatenated verified credential IDs grouped by credential format.

Show child attributes

verifiedCredentialsHashes. blockchain · string

verifiedCredentialsHashes. email · string

verifiedCredentialsHashes. oauth · string

verifiedCredentialsHashes. phoneNumber · string

verifiedCredentialsHashes. externalUser · string

info · object

Show child attributes

info. environmentId · string · required

Required string length: 36

Example:

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

info. alias · string

info. chain · enum<string>

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

info. email · string<email>

info. ens · object

Show child attributes

info.ens. avatar · string

info.ens. name · string

info. firstName · string

info. jobTitle · string

info. lastName · string

info. lists · string[]

info. phoneNumber · string

info. tShirtSize · string

info. userId · string

Required string length: 36

Example:

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

info. username · string

info. wallet · string

info. walletPublicKey · string

Required string length: 36

Example:

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

server_auth · boolean