Rest API
- Introduction
- allowlists
- analytics
- chainalysis
- chains
- custom fields
- environments
- events
- exports
- externaljwt
- gates
- members
- organizations
- origins
- projects
- invites
- sdk views
- settings
- tokens
- sessions
- users
- wallets
- webhooks
- Schemas
Creates a new user
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ID of the environment
User fields that can be updated on dashboard or through the rest API which do not involve any uniqueness checks or further verification
Standard ISO 3166-1 alpha-2 two-letter country code
Alphanumeric with slugs and underscores username
BTC wallet address
KDA wallet address
LTC wallet address
CKB wallet address
KAS wallet address
DOGE wallet address
When provided, the user email will be marked as verified in our system and the user will be allowed to sign in with that email. When social is enabled and the social provider has a verified email, we will automatically associate that social with the existing user.
If email is trusted and verified, please provide a emailVerifiedAt timestamp. This will ensure that a user signing in with this email can access the correctly-created user account.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the environment
36Body
User fields that can be updated on dashboard or through the rest API which do not involve any uniqueness checks or further verification
36255255255255255pending, complete 255255Standard ISO 3166-1 alpha-2 two-letter country code
255Alphanumeric with slugs and underscores username
255BTC wallet address
KDA wallet address
LTC wallet address
CKB wallet address
KAS wallet address
DOGE wallet address
When provided, the user email will be marked as verified in our system and the user will be allowed to sign in with that email. When social is enabled and the social provider has a verified email, we will automatically associate that social with the existing user.
If email is trusted and verified, please provide a emailVerifiedAt timestamp. This will ensure that a user signing in with this email can access the correctly-created user account.
255Valid blockchain wallet address, must be an alphanumeric string without any special characters
255ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC 255browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet 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 255255255Response
3636Valid blockchain wallet address, must be an alphanumeric string without any special characters
255363636This 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.
browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet 363636Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.
36V1, V2 blockchain, email, oauth, passkey, phoneNumber, externalUser 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 This field contains the phone number in the country. This could also contain the area code within a country.
This field contains the phone international country code. See https://countrycode.org/
ISO-3166 two-character country code. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
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.
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.
An address associated with a wallet.
The public key associated with the address.
ordinals, payment, cosmos, evm 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.
3636255Standard ISO 3166-1 alpha-2 two-letter country code
255255255255255255255255255pending, complete Access lists evaluated by Dynamic when considering access for the user.
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
standard, custom Optional validation rules for the custom field
If this field must be unique for every user in the environment
The regex pattern that the text field must match
255The text that will be displayed for the checkbox field
255text, checkbox, select ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC 36ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC Valid blockchain wallet address, must be an alphanumeric string without any special characters
255browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet 363636Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.
36V1, V2 36OK, BLOCKED, FAILED Valid blockchain wallet address, must be an alphanumeric string without any special characters
25536emailOnly, magicLink, apple, bitbucket, coinbasesocial, discord, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, blocto, banxa, dynamic, alchemy, zerodev, telegram, turnkey, coinbaseWaas, sms totp, passkey Whether or not the user has a verified this MFA Device
36The date and time the MFA device was created
The date and time the MFA device was verified
Whether or not this is the default MFA device for the user
The optional alias for the MFA device
Was this page helpful?