OrganizationMember

string

required

Required string length: 36

Example:

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

user

object

required

user.id

string

required

Required string length: 36

Example:

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

user.projectEnvironmentId

string

required

Required string length: 36

Example:

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

user.verifiedCredentials

object[]

user.verifiedCredentials.id

string

required

Required string length: 36

Example:

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

user.verifiedCredentials.format

enum<string>

required

Available options:

blockchain,

email,

oauth,

passkey,

phoneNumber,

externalUser

This indicates if the user can sign in with this credential

user.verifiedCredentials.address

string

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

Maximum length: 255

Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

user.verifiedCredentials.chain

string

user.verifiedCredentials.refId

string

Required string length: 36

Example:

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

user.verifiedCredentials.signerRefId

string

Required string length: 36

Example:

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

user.verifiedCredentials.email

string

user.verifiedCredentials.name_service

object

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

user.verifiedCredentials.wallet_name

string

user.verifiedCredentials.wallet_provider

enum<string>

Available options:

browserExtension,

custodialService,

walletConnect,

qrCode,

deepLink,

embeddedWallet,

smartContractWallet

user.verifiedCredentials.wallet_properties

object

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

user.verifiedCredentials.oauth_username

string

user.verifiedCredentials.oauth_display_name

string | null

user.verifiedCredentials.oauth_account_id

string | null

user.verifiedCredentials.phoneNumber

string

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

Example:

"9171113333"

user.verifiedCredentials.phoneCountryCode

string

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

Example:

"1"

user.verifiedCredentials.isoCountryCode

string

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

Example:

"US"

user.verifiedCredentials.oauth_account_photos

string[]

user.verifiedCredentials.oauth_emails

string[]

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

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

user.verifiedCredentials.embedded_wallet_id

string | null

user.verifiedCredentials.wallet_additional_addresses

object[]

An additional address associated with a wallet.

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

user.lastVerifiedCredentialId

string

Required string length: 36

Example:

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

user.sessionId

string

Required string length: 36

Example:

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

user.alias

string | null

Maximum length: 255

Example:

"An example name"

user.country

string | null

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

Maximum length: 255

Example:

"US"

user.email

string | null

Maximum length: 255

user.firstName

string | null

Maximum length: 255

Example:

"An example name"

user.jobTitle

string | null

Maximum length: 255

Example:

"An example name"

user.lastName

string | null

Maximum length: 255

Example:

"An example name"

user.phoneNumber

string | null

Maximum length: 255

user.tShirtSize

string | null

Maximum length: 255

Example:

"An example name"

user.team

string | null

Maximum length: 255

Example:

"An example name"

user.username

string | null

Maximum length: 255

Example:

"An example name"

user.firstVisit

string

user.lastVisit

string

user.newUser

boolean

user.metadata

object

user.mfaBackupCodeAcknowledgement

enum<string> | null

Available options:

pending,

complete

user.btcWallet

string | null

user.kdaWallet

string | null

user.ltcWallet

string | null

user.ckbWallet

string | null

user.kasWallet

string | null

user.dogeWallet

string | null

user.emailNotification

boolean | null

user.discordNotification

boolean | null

user.lists

string[]

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

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"

user.missingFields

object[]

user.missingFields.name

string

required

user.missingFields.required

boolean

required

user.missingFields.enabled

boolean

required

user.missingFields.unique

boolean

required

user.missingFields.verify

boolean

required

user.missingFields.type

enum<string>

Available options:

standard,

custom

user.missingFields.validationRules

object

Optional validation rules for the custom field

user.missingFields.validationRules.unique

boolean

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

user.missingFields.validationRules.regex

string

The regex pattern that the text field must match

Maximum length: 255

Example:

"^0x"

user.missingFields.validationRules.validOptions

object[]

The dropdown options for the select field

Example:

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

user.missingFields.validationRules.checkboxText

string

The text that will be displayed for the checkbox field

Maximum length: 255

Example:

"Agree to the terms and conditions"

user.missingFields.validationType

enum<string>

Available options:

text,

checkbox,

select

user.missingFields.label

string

user.missingFields.position

number

user.walletPublicKey

string

user.wallet

string

user.chain

enum<string>

Available options:

ETH,

EVM,

FLOW,

SOL,

ALGO,

STARK,

COSMOS,

BTC,

ECLIPSE

user.createdAt

string

user.updatedAt

string

user.sessions

object[]

user.wallets

object[]

user.chainalysisChecks

object[]

user.oauthAccounts

object[]

user.mfaDevices

object[]

role

enum<string>

required

Available options:

owner,

admin,

developer,

viewer

Was this page helpful?

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "user": {
    "id": "95b11417-f18f-457f-8804-68e361f9164f",
    "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
    "verifiedCredentials": [
      {
        "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "chain": "<string>",
        "refId": "95b11417-f18f-457f-8804-68e361f9164f",
        "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
        "email": "jsmith@example.com",
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "name_service": {
          "avatar": "<string>",
          "name": "<string>"
        },
        "public_identifier": "<string>",
        "wallet_name": "<string>",
        "wallet_provider": "browserExtension",
        "wallet_properties": {
          "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
          "isAuthenticatorAttached": true,
          "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f",
          "isSessionKeyCompatible": true,
          "version": "V1",
          "ecdsaProviderType": "zerodev_signer_to_ecdsa",
          "entryPointVersion": "v6",
          "kernelVersion": "v2_4"
        },
        "format": "blockchain",
        "oauth_provider": "emailOnly",
        "oauth_username": "<string>",
        "oauth_display_name": "<string>",
        "oauth_account_id": "<string>",
        "phoneNumber": "9171113333",
        "phoneCountryCode": "1",
        "isoCountryCode": "US",
        "oauth_account_photos": [
          "<string>"
        ],
        "oauth_emails": [
          "<string>"
        ],
        "oauth_metadata": {},
        "previous_users": [
          "95b11417-f18f-457f-8804-68e361f9164f"
        ],
        "embedded_wallet_id": "<string>",
        "wallet_additional_addresses": [
          {
            "address": "<string>",
            "publicKey": "<string>",
            "type": "ordinals"
          }
        ],
        "lastSelectedAt": "2023-11-07T05:31:56Z",
        "signInEnabled": true
      }
    ],
    "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
    "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
    "alias": "An example name",
    "country": "US",
    "email": "jsmith@example.com",
    "firstName": "An example name",
    "jobTitle": "An example name",
    "lastName": "An example name",
    "phoneNumber": "<string>",
    "policiesConsent": true,
    "tShirtSize": "An example name",
    "team": "An example name",
    "username": "An example name",
    "firstVisit": "2023-11-07T05:31:56Z",
    "lastVisit": "2023-11-07T05:31:56Z",
    "newUser": true,
    "metadata": {},
    "mfaBackupCodeAcknowledgement": "pending",
    "btcWallet": "<string>",
    "kdaWallet": "<string>",
    "ltcWallet": "<string>",
    "ckbWallet": "<string>",
    "kasWallet": "<string>",
    "dogeWallet": "<string>",
    "emailNotification": true,
    "discordNotification": true,
    "newsletterNotification": true,
    "lists": [
      "<string>"
    ],
    "scope": "superuser marketing operations",
    "missingFields": [
      {
        "name": "<string>",
        "required": true,
        "enabled": true,
        "unique": true,
        "verify": true,
        "type": "standard",
        "validationRules": {
          "unique": true,
          "regex": "^0x",
          "validOptions": [
            {
              "label": "small"
            },
            {
              "label": "medium"
            },
            {
              "label": "large"
            }
          ],
          "checkboxText": "Agree to the terms and conditions"
        },
        "validationType": "text",
        "label": "<string>",
        "position": 123
      }
    ],
    "walletPublicKey": "<string>",
    "wallet": "<string>",
    "chain": "ETH",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "sessions": [
      {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "createdAt": "2023-11-07T05:31:56Z",
        "ipAddress": "<string>",
        "userAgent": "<string>",
        "revokedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "wallets": [
      {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "name": "An example name",
        "chain": "ETH",
        "publicKey": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "provider": "browserExtension",
        "properties": {
          "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
          "isAuthenticatorAttached": true,
          "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f",
          "isSessionKeyCompatible": true,
          "version": "V1",
          "ecdsaProviderType": "zerodev_signer_to_ecdsa",
          "entryPointVersion": "v6",
          "kernelVersion": "v2_4"
        },
        "lastSelectedAt": "<string>"
      }
    ],
    "chainalysisChecks": [
      {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "createdAt": "2023-11-07T05:31:56Z",
        "result": "OK",
        "walletPublicKey": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "response": "<string>"
      }
    ],
    "oauthAccounts": [
      {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "provider": "emailOnly",
        "accountUsername": "<string>"
      }
    ],
    "mfaDevices": [
      {
        "type": "totp",
        "verified": true,
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "createdAt": "2023-11-07T05:31:56Z",
        "verifiedAt": "2023-11-07T05:31:56Z",
        "default": true,
        "alias": "<string>"
      }
    ]
  },
  "role": "owner"
}

Rest API

GlobalWallets

NameServices

TestAccount

CustomHostnames

Exports

Gates

Settings

Analytics

Organizations

Projects

Custom Networks

Chainalysis

Environments

Sessions

Wallets

Users

Visits

Members

MfaSettings

Invites

ExternalJwt

Origins

UserApiTokens

Tokens

Allowlists

Chains

SDK Views

Events

Webhooks

SDK

Custom Fields

DeeplinkUrls

Mfa

OrganizationMember