- Announcements
- System Status
- 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
Rest API
Creates many new users
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ID of the environment
Update user data if user already exists
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the environment
Query Parameters
Update user data if user already exists
Body
ID of the environment
pending, complete 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
Valid blockchain wallet address, must be an alphanumeric string without any special characters
ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet An address associated with a wallet.
The public key associated with the address.
ordinals, payment 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 Response
ID of the environment
ID of the environment
Valid blockchain wallet address, must be an alphanumeric string without any special characters
ID of the environment
ID of the environment
ID of the environment
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.
browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet ID of the environment
ID of the environment
ID of the environment
Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.
ID of the environment
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 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.
ID of the environment
ID of the environment
Standard ISO 3166-1 alpha-2 two-letter country code
pending, 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
The dropdown options for the select field
The text that will be displayed for the checkbox field
text, checkbox, select ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC ID of the environment
ID of the environment
ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC Valid blockchain wallet address, must be an alphanumeric string without any special characters
browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet ID of the environment
ID of the environment
ID of the environment
Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.
ID of the environment
ID of the environment
OK, BLOCKED, FAILED Valid blockchain wallet address, must be an alphanumeric string without any special characters
ID of the environment
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 ID of the environment
ID of the environment
Valid blockchain wallet address, must be an alphanumeric string without any special characters
ID of the environment
ID of the environment
ID of the environment
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.
browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet ID of the environment
ID of the environment
ID of the environment
Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.
ID of the environment
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 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.
ID of the environment
ID of the environment
Standard ISO 3166-1 alpha-2 two-letter country code
pending, 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
The dropdown options for the select field
The text that will be displayed for the checkbox field
text, checkbox, select ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC ID of the environment
ID of the environment
ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC Valid blockchain wallet address, must be an alphanumeric string without any special characters
browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet ID of the environment
ID of the environment
ID of the environment
Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.
ID of the environment
ID of the environment
OK, BLOCKED, FAILED Valid blockchain wallet address, must be an alphanumeric string without any special characters
ID of the environment
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 ID of the environment
ID of the environment
Valid blockchain wallet address, must be an alphanumeric string without any special characters
ID of the environment
ID of the environment
ID of the environment
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.
browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet ID of the environment
ID of the environment
ID of the environment
Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.
ID of the environment
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 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.
ID of the environment
ID of the environment
Standard ISO 3166-1 alpha-2 two-letter country code
pending, 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
The dropdown options for the select field
The text that will be displayed for the checkbox field
text, checkbox, select ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC ID of the environment
ID of the environment
ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC Valid blockchain wallet address, must be an alphanumeric string without any special characters
browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet ID of the environment
ID of the environment
ID of the environment
Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.
ID of the environment
ID of the environment
OK, BLOCKED, FAILED Valid blockchain wallet address, must be an alphanumeric string without any special characters
ID of the environment
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 email_already_exists, allowlist_already_exists, allowlist_entry_already_exists, reassign_wallet_error, reassign_wallet_confirm, members_cannot_delete_themself, username_already_exists, wrong_email_verification_token, wrong_sms_verification_token, invalid_email_verification, invalid_sms_verification, invalid_verification, too_many_sms_verification_attempts, too_many_email_verification_attempts, too_many_verification_attempts, organization_name_already_exists, project_name_already_exists, wallet_not_deployed, email_verification_required, phone_verification_required, invite_address_required, provider_not_available, forbidden_unlink_request, invalid_unlink_request, too_many_api_tokens, lock_timeout, lock_too_many_attempts, nft_token_gating_not_supported_for_chain, empty_chain_name, no_enabled_email_provider, no_enabled_sms_provider, invalid_key_export_url, invalid_dynamic_props, too_many_requests, too_many_organizations_for_user, too_many_projects_for_organization, email_associated_with_different_provider, user_has_already_account_with_email, user_has_already_account_with_phone_number, other_verify_failure, email_tied_to_embedded_wallet, invalid_invite, social_account_already_exists, invalid_email_address, invalid_gate, conflicting_embedded_wallet_providers, invalid_user, invalid_cors_origins, invalid_mobile_deeplink_urls, unauthorized_mobile_deeplink_url, invalid_private_key_format, invalid_embedded_wallet_settings, wallet_not_support_passkey, recovery_email_unavailable_or_invalid, connect_error, invalid_wallet_name, invalid_wallet_address, email_recovery_disabled, no_compatible_wallet_service_enabled, missing_aa_project_id, linked_embedded_wallet, invalid_mpc_environment, invalid_regex, repeated_options, missing_phone_number_or_email, duplicate_exists, mfa_device_not_found, mfa_invalid_code, mfa_invalid_request, invalid_phone, gate_exists, invalid_embedded_wallet_chains_configuration, merge_accounts_confirmation, merge_accounts_invalid, invalid_wallet_id, unable_to_fetch_balances, cannot_switch_to_unique, custom_field_data_not_unique, metadata_size_exceeded, invalid_custom_hostname, blocked_user_cannot_transfer_wallet, feature_not_enabled_in_suborg, invalid_username, invalid_external_auth, invalid_chain_address_match, invalid_update, cannot_delete_last_project Was this page helpful?