System Status

Changelog

Dynamic

React SDK

React Native SDK

Flutter SDK

API Reference

Troubleshooting

Live Support

Start Free

Explore Dynamic

Creates a new wallet for the user. Note that this API is not meant for creating embedded wallets. To create embedded wallets use the /embeddedWallets endpoint.

Creates a new wallet for the user

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

Dynamic pregenerated this wallet and stored the passcode

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

Optional validation rules for the custom field

The text that will be displayed for the checkbox field

The regex pattern that the text field must match

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

The dropdown options for the select field

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

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.

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 field contains the phone international country code. See https://countrycode.org/

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

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.

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.

This indicates if the user can sign in with this credential

Contains information needed for the SDK to surface merge conflicts when attempting to merge information from one user to another

Contains the current field value for the user.

Contains a merge conflict between two users with different values for the same user field data

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

Contains information which the integrating client of this API can use to tailor an experience to a customer to fix the underlying issue that triggered this error.

An additional address associated with a wallet.

The public key associated with the address.

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

bearerAuth

Creates a new wallet for the user. Note that if the user already has an embedded wallet linked, this call will fail.

Welcome to Dynamic! We're so excited that you're here!

Welcome

Let's get you up and running with a React based signup/login UI! Just [sign up](https://app.dynamic.xyz) and follow the guide below!

Quickstart

Example apps

Go Live Checklist

Best Practices

Adding the SDK

DynamicContextProvider props

Wagmi & Dynamic

Using Ethers instead of Viem

Enabling Chains

Embedded Wallet Chains

Smart Wallet Chains

Using RPC Providers

Custom EVM networks

Custom Cosmos network

Switching Networks

Sign Up with Email/Social/SMS

Sign Up with Branded Wallets

JWTs/Authentication Tokens

Cookie Based Authentication

Adding Captcha Protection

Server-side verification

Third-party Authentication

Multi-Factor Authentication (MFA)

Multi Wallet

Multi Asset UI

Send Assets

Accessing Users

Verified Credentials

Email and Phone Verification

Social Linking

UI Customization Overview

Customizing Signup/Login UI

Adapt Copy With Translations

Adapt UI With Views

Customizing Transaction UI

Banxa

Bring Your Own Onramp

Headless Overview

Headless Email Signup

Headless SMS signup

Headless Social Login

Headless Embedded Wallets With OTP

Headless embedded wallets using Passkeys

Headless Embedded Wallet Export

Headless Wallet Management

Headless User Profile

Headless MFA

Overview

QR Scanning (Global Connectivity)

Web3 Wallet Libraries

The `DynamicBridgeWidget` component allows you to handle multi chain bridging

Bridge Widget

Rate Limits

This page hosts the keys that you'll need to setup the SDK, validate the JWT, and generate tokens for API usage.

SDK and API Keys

Every project you create in Dynamic comes with a Sandbox and a Live environment. Both these environments behave similarly but we've customized the Sandbox environment to make it ideal for testing and exploring features.

Sandbox vs Live

Analytics

Users

Visitors

Test Accounts allow you to log in with a static OTP

Test Accounts

One of the first things you'll want to do as you create a new project is update some of the basic metadata associated with the SDK such as your app name, logo url, and support url.

General Settings

Privacy Settings

We take security seriously at Dynamic and most of the work we do is behind the scenes so you don't have to worry about it. We will surface some security features that can be configured. 

Security Settings

Invite Members

Projects vs Organizations

General

Webhook Event types

Social Providers Overview

Farcaster Overview

Sign in with Farcaster

Enable Write Access to Farcaster

Generate an multi-chain embedded wallet from a Farcaster frame

Telegram Mini App

Telegram Auto-Wallets

Phantom Redirect

NextAuth & Dynamic

Create-web3-dapp & Dynamic

Dynamic in PWA

How to Use Dynamic in a Safe App

Shield3 & Dynamic Integration

XMTP & Dynamic Integration

Verifying webhook message signatures

Add new users to your CRM

Webhooks using a serverless function

Post in a slack channel when you have a new signup

Slack notifications of new signups

Send new users an XMTP message

Migrating to Dynamic

Migrating Users via CSV

Migration from RainbowKit

Integrate your Wallet

Integrate your Chain

Dynamic Doctor

Cannot resolve rpc-websockets

Cannot convert a BigInt value to a number

Failed to parse source map warnings

Jest Error: SyntaxError: Cannot use import statement outside a module

NextJS with React 17 With Dynamic React SDK >=0.14.0

Modal pop up isn't visible

Vite.js polyfills necessary for Dynamic SDK

Module not found: Can't resolve 'encoding'

FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed

Hydration failed because initial UI does not match what was rendered on the server

Wallet is redirecting to the App Store

Working with environments that have both v1 and v2 embedded wallets

WalletConnect Unsupported Chain

Module not found Error (Framer-motion/browser.js)

React Static Flag Error

TypeScript Compilation Errors

The SDK allows you to build authentication and authorization into your application in a few lines of code.

Introduction to the SDK

SDK/User Loading States

Examples

Introduction to the React Native SDK

Setting up the Dynamic Client

Adding React Native support

Email and SMS verification

Social authentication

Install & Setup Passkey

Embedded wallets

Rendering client state to React

Managing your User's Wallets

Viem integration

Solana integration

Using Dynamic's UI

Account Abstraction with ZeroDev

Listening to events

Deeplink URLs

Signing in with Third-party Authentication

Troubleshooting Common Issues

Dynamic Package

Social Authentication

Web3Dart Package

Introduction

Create new allowlist for a environment

Delete an allowlist

Delete an allowlist entry

Disable the allow list

Enable the allowlist

Get all allowlists for a environment

Get allowlist by id

Get all entries for an allowlist

Create a new entry for an allowlist

Update the outcome, scope, or name of an allowlist entry by ID

getVisitAnalytics

Fetch visit analytics

Disables the Sanctions API

Enable the Sanctions API

Find the Chainalysis configuration for an environment.

Get tokens for passed chainName.

Create a new custom field for an environment

Delete a specific custom field by its ID

Retrieve a specific custom field by its ID

Get the custom fields for an environment

Rest API

Creates a new wallet for the user

Authorizations

Path Parameters

Body

Response