Update a user's fields

PUT

sdk

{environmentId}

users

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId

string

required

ID of the environment

Body

application/json

string

alias

string

firstName

string

lastName

string

jobTitle

string

phoneNumber

string

tShirtSize

string

team

string

policiesConsent

boolean

country

string | null

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

username

string | null

Alphanumeric with slugs and underscores username

captchaToken

string

When provided, used to verify that a captcha is valid and get the success/failure result from the captcha provider server-side.

metadata

object

mfaBackupCodeAcknowledgement

enum<string> | null

Available options:

pending,

complete

btcWallet

string | null

BTC wallet address

kdaWallet

string | null

KDA wallet address

ltcWallet

string | null

LTC wallet address

ckbWallet

string | null

CKB wallet address

kasWallet

string | null

KAS wallet address

dogeWallet

string | null

DOGE wallet address

emailNotification

boolean

discordNotification

boolean

newsletterNotification

boolean

Response

200 - application/json

mfaToken

string

jwt

string

Encoded JWT token. This will only be returned when cookie-based authentication is disabled in favor of standard Auth header based authentication.

user

object

required

user.id

string

required

ID of the environment

user.projectEnvironmentId

string

required

ID of the environment

user.verifiedCredentials

object[]

required

user.verifiedCredentials.address

string

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

user.verifiedCredentials.chain

string

user.verifiedCredentials.refId

string

ID of the environment

user.verifiedCredentials.signerRefId

string

ID of the environment

user.verifiedCredentials.email

string

user.verifiedCredentials.id

string

required

ID of the environment

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

enum<string>

required

Available options:

blockchain,

email,

oauth,

passkey,

phoneNumber,

externalUser

user.verifiedCredentials.oauth_provider

enum<string>

Available options:

emailOnly,

magicLink,

apple,

bitbucket,

coinbasesocial,

discord,

facebook,

farcaster,

github,

gitlab,

google,

instagram,

linkedin,

microsoft,

twitch,

twitter,

blocto,

banxa,

dynamic,

alchemy,

zerodev,

telegram,

turnkey,

coinbaseWaas,

sms

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.

user.verifiedCredentials.phoneCountryCode

string

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

user.verifiedCredentials.isoCountryCode

string

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

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[]

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

ID of the environment

user.sessionId

string

ID of the environment

user.alias

string | null

user.country

string | null

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

user.email

string | null

user.firstName

string | null

user.jobTitle

string | null

user.lastName

string | null

user.phoneNumber

string | null

user.policiesConsent

boolean | null

user.tShirtSize

string | null

user.team

string | null

user.username

string | null

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

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

user.missingFields

object[]

minifiedJwt

string

Encoded JWT token. This will only be returned when cookie-based authentication is disabled in favor of standard Auth header based authentication.

expiresAt

number

required

Format is a unix-based timestamp. When set, this will be the expiration timestamp on the JWT sent using either the jwt field or a response httpOnly cookie set by the server.

nextView

enum<string>

required

Available options:

done,

verify-email,

verified-and-transferred,

verify-sms

emailVerification

object

smsVerification

object

Was this page helpful?

Rest API

Authorizations

Path Parameters

Body

Response