Props

Methods

System Status

Changelog

Dynamic

SDKs

API Reference

Live Support

Start Free

Explore Dynamic

An object containing the attributes about the user wallets.

Wallet

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

Developer 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 (EvmNetwork)

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 Balance UI

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

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

Banxa

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

Dynamic Bridge Widget

bridgeChains

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

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

Phantom Redirect

NextAuth & Dynamic

Create-web3-dapp & Dynamic

Dynamic in PWA

Deploy a Safe account with Dynamic

Telegram Mini App

Telegram Auto-Wallets

Co:Create & Dynamic Integration

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

SDKs Overview

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

Deeplink URLs

Signing in with Third-party Authentication

Troubleshooting Common Issues

Dynamic Package

Web3Dart Package

Dynamic Doctor

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

Update an existing custom field by its ID

Deletes an environment by ID

Find an environment by ID

Get Live and Sandbox environments by projectId

Get keys for an environment given environmentId

Get the unique number of visitors for an environment by environment ID

Updates the environment settings

Get event types

Get environment events

Create a new export request for the project environment

Download an export by ID

Get the exports for an environment

Get an export using the ID

Check if the external provided JWT is valid for the specified environment

Creates a new gate for the project environment

Delete a gate

Disable the gate for the environment

Enable the gate for the environment

Get the gates for an environment

Gets a gate

Updates a gate

Delete user membership from being an admin of an organization

Get all users that are admins for an organization

Retrieve the list of project environments that the user is a member of.

Get Membership Environment IDs

Update a given members role

Creates organization

Deletes an organization by ID

Find the subscription of an organization using its ID

Find an organization by ID

Fetches all the active organizations that the user has access to

Update an organization by ID

Upgrade organziation to advanced plan

Adds an allowed origin for this project environment

Delete a origin by id

Get all the allowed origins for a project environment

Creates a new project

Deletes a project by ID

Find an project by ID

Fetches all the active projects the belong to the organization

Update a project

Creates an invite to the organization

Delete invite for user

Get all the user invites

Fetches all the Invites the belong to the organization

Update invite for user (accept/reject)

Get a sdk view given a type and environment

Get the sdk views for an environment

Updates the configs for the sdk view and project environment

Creates a new provider for the project environment

Delete a provider by providerId

Disable the provider for the environment

Enable the provider for the environment

Field	Description
additionalAddresses: WalletAdditionalAddress[]	Additional addresses associated to the wallet (e.g. ordinals and payment addresses for bitcoin wallets)
address: string	Public address of the connected wallet
chain: string	Current BlockChain name (e.g: ‘ETH’, ‘SOL’, ‘BTC’, etc)
connector: WalletConnector	The wallet connector object
id: string	The wallet’s unique id (matches thw wallet verified credential on connect-anf-sign)
isAuthenticated: boolean	True if the user is authenticated, otherwise it’s false
key: string	The wallet key (e.g. metamask, phantom, etc)

Method	Description
getBalance(): Promise<string \| undefined>	Retrieves the balance of the wallet.
getNameService(): Promise<NameServiceData \| undefined>	Retrieves the name service data associated with the wallet.
isConnected(): Promise<boolean>	If the wallet is connected.
proveOwnership(messageToSign: string): Promise<string\ \| undefined>	Proves ownership of the wallet by signing a message.
signMessage(messageToSign: string): Promise<string\ \| undefined>	Signs a message using the wallet.
switchNetwork(networkChainId: number \| string): Promise<void>	Switches the network that the wallet is connected to.
sync(): Promise<void>	Prompts the user to reconnect the wallet if not connected and only resolves when the wallet is connected and active.

SDKs

​Props

​Methods

Props

Methods