ProjectSettingsSdk

nameService

object

Show child attributes

nameService.evm

object

required

Show child attributes

nameService.evm.domain

string

Top-level ENS domain for the environment for EVM embedded wallets in this environment

featureFlags

object

Show child attributes

featureFlags.connectOnlyMultiAsset

boolean

required

featureFlags.enableExchanges

boolean

required

Show child attributes

The 'turnkey' value is deprecated and will be removed in a future version.

Available options:

dynamic,

magicLink,

blocto,

turnkey,

coinbaseWaas

Show child attributes

The 'turnkey' value is deprecated and will be removed in a future version.

Available options:

dynamic,

magicLink,

blocto,

turnkey,

coinbaseWaas

Show child attributes

Available options:

apple,

bitbucket,

coinbasesocial,

discord,

epicgames,

facebook,

farcaster,

github,

gitlab,

google,

instagram,

linkedin,

microsoft,

twitch,

twitter,

telegram,

spotify,

tiktok,

line,

steam,

shopify,

kraken,

okta

exchangeOptions

object[]

Show child attributes

exchangeOptions.exchange

enum<string>

required

Source exchange identifier

Available options:

coinbase,

kraken

The 'turnkey' value is deprecated and will be removed in a future version.

Available options:

emailOnly,

magicLink,

apple,

bitbucket,

coinbasesocial,

discord,

epicgames,

facebook,

farcaster,

github,

gitlab,

google,

instagram,

linkedin,

microsoft,

twitch,

twitter,

blocto,

banxa,

coinbaseOnramp,

cryptoDotCom,

dynamic,

alchemy,

zerodev,

telegram,

turnkey,

coinbaseWaas,

sms,

spotify,

tiktok,

line,

steam,

shopify,

zksync,

kraken,

blockaid,

passkey,

okta,

sendgrid,

resend

exchangeOptions.onRampProvider

enum<string>

The 'turnkey' value is deprecated and will be removed in a future version.

Available options:

emailOnly,

magicLink,

apple,

bitbucket,

coinbasesocial,

discord,

epicgames,

facebook,

farcaster,

github,

gitlab,

google,

instagram,

linkedin,

microsoft,

twitch,

twitter,

blocto,

banxa,

coinbaseOnramp,

cryptoDotCom,

dynamic,

alchemy,

zerodev,

telegram,

turnkey,

coinbaseWaas,

sms,

spotify,

tiktok,

line,

steam,

shopify,

zksync,

kraken,

blockaid,

passkey,

okta,

sendgrid,

resend

multiWallet

boolean

multiWalletUnlinkDisabled

boolean

mobile

object

Show child attributes

mobile.deeplinkUrlsEnabled

boolean

Whether to enable whitelisting mobile deeplink URLs, which will be used for redirecting back to the mobile app. Is required for many features such as social sign in.

confirmWalletTransfers

boolean

onrampFunding

boolean

passkeyEmbeddedWalletEnabled

boolean

deprecated

passkeyEmbeddedWalletEnabled is deprecated as of v0.19. Please enable embedded wallets using the provider API.

automaticEmbeddedWalletCreation

boolean

passkeyEmbeddedWalletRecoveryEnabled

boolean

embeddedWalletSecurityMethods

enum<string>[]

Embedded wallet authenticator security methods required upon creation of the embedded wallet at onboarding

Available options:

passkey,

passphrase

embeddedWallets

object

Show child attributes

embeddedWallets.automaticEmbeddedWalletCreation

boolean

When true embedded wallets will be generated during onboarding for the users. When false customer needs to trigger the creation.

embeddedWallets.automaticEmbeddedWalletCreationForExternal

boolean

When true embedded wallets will be created for external wallets during sign in. When false embedded wallets are not generated for external wallets during sign in.

embeddedWallets.showEmbeddedWalletActionsUI

boolean

When true users will see embedded wallets action confirmation views.

embeddedWallets.emailRecoveryEnabled

boolean

When true users will be able to start recovery for their accounts.

When true user will be prompted to add a security method during onboarding. When false user will need to add a security method before a transaction

When combined with forceAuthenticatorAtSignup it allows user to skip adding a security method during onboarding. User will need to add it before a transaction.

embeddedWallets.sessionKeyDuration

object

Show child attributes

embeddedWallets.sessionKeyDuration.amount

integer

required

embeddedWallets.sessionKeyDuration.unit

enum<string>

required

Available options:

days,

hours,

minutes

embeddedWallets.supportedSecurityMethods

object

Show child attributes

embeddedWallets.supportedSecurityMethods.passkey

object

Show child attributes

embeddedWallets.supportedSecurityMethods.passkey.isDefault

boolean

required

embeddedWallets.supportedSecurityMethods.passkey.isEnabled

boolean

required

embeddedWallets.supportedSecurityMethods.passkey.isPermanentAuthenticator

boolean

required

embeddedWallets.supportedSecurityMethods.passkey.listPosition

number

required

embeddedWallets.supportedSecurityMethods.email

object

Show child attributes

embeddedWallets.supportedSecurityMethods.email.isDefault

boolean

required

embeddedWallets.supportedSecurityMethods.email.isEnabled

boolean

required

embeddedWallets.supportedSecurityMethods.email.isPermanentAuthenticator

boolean

required

embeddedWallets.supportedSecurityMethods.email.listPosition

number

required

embeddedWallets.supportedSecurityMethods.password

object

Show child attributes

embeddedWallets.supportedSecurityMethods.password.isDefault

boolean

required

embeddedWallets.supportedSecurityMethods.password.isEnabled

boolean

required

embeddedWallets.supportedSecurityMethods.password.isPermanentAuthenticator

boolean

required

embeddedWallets.supportedSecurityMethods.password.listPosition

number

required

embeddedWallets.chainConfigurations

object[]

Chain specific configuration for dynamic embedded wallets

Show child attributes

embeddedWallets.chainConfigurations.name

string

required

embeddedWallets.chainConfigurations.enabled

boolean

required

embeddedWallets.chainConfigurations.primary

boolean

required

embeddedWallets.domainEnabledByProvider

boolean

When a client domain needs to be whitelisted explicitly by one of our embedded wallet providers, this will be true when Dynamic has confirmed that this is the case.

embeddedWallets.defaultWalletVersion

enum<string>

Available options:

V1,

V2,

V3

embeddedWallets.promptForKeyExport

boolean

When true, the user will be prompted to export their private key after creating a wallet.

embeddedWallets.transactionSimulation

boolean

When true, user transactions will show asset transfers in the Confirmation UI.

waas

object

Show child attributes

waas.passcodeRequired

boolean

required

When true, passcode security method is forced for v3 embedded wallets. Usually it is an optional security method.

Show child attributes

When true, backup options are shown during sign up for v3 embedded wallets.

When true, users will be prompted to export their client share.

waas.backupOptions

enum<string>[]

required

Available options:

googleDrive,

icloud,

dynamic,

external,

delegated

waas.allowMultipleWaasWalletsPerChain

boolean

When true, users can have multiple WAAS wallets per chain.

waas.relayUrl

string

The URL of the relay server for the environment. If not provided, the default relay server will be used.

waas.delegatedAccessEndpoint

string

The URL of the delegated access endpoint for WAAS. If not provided, no delegated access endpoint will be used.

waas.delegatedAccess

object

Show child attributes

waas.delegatedAccess.enabled

boolean

Whether delegated access is enabled for the environment. If enabled, developer can trigger user to accept delegated access.

Prompt for delegated access when user logs in.

waas.delegatedAccess.requiresDelegation

boolean

If enabled, users will be required to delegate access.

waas.enableForwardMPCClient

boolean

When true, the sdk will utilize the forward MPC client for select MPC operations.

walletConnect

object

Show child attributes

walletConnect.projectId

string

walletConnect.v2Enabled

boolean

walletConnect.walletProjectId

string

confirmEmailProviderForVerify

boolean

displayDynamicMessaging

boolean

preventOrphanedAccounts

boolean

views

object[]

Configs used to create the views in the sdk.

Show child attributes

views.type

enum<string>

required

Available options:

login

views.sections

object[]

The sections which will be used create the view in the sdk. The sections will be displayed in the order that they appear in the array.

Show child attributes

views.sections.type

enum<string>

required

Available options:

email,

emailAndPhone,

phone,

separator,

social,

text,

wallet,

passkey

views.sections.label

string

The label for the section. This will be displayed above the section or as part of the separator component if it is a Separator section.

views.sections.numOfItemsToDisplay

integer

The deafult number of items to display in the section. For Wallet section, represents the number of wallet items to be displayed by default. User has to click a button to view more options if there are any. For Social section, represents the number of social providers to be displayed by default. User has to click a button to view more options if there are any.

views.sections.defaultItem

string

The option to be displayed as the main one. The default item will be displayed in a more prominent way than the rest of the items in the section. For Wallet section, represents the wallet item to be displayed by default. For Social section, represents the social provider to be displayed by default.

views.sections.alignment

enum<string>

Available options:

center,

left,

right

accountAbstraction

object

Show child attributes

accountAbstraction.allWallets

boolean

If set to false, will create smart wallets for embedded wallets only.

accountAbstraction.allUsers

boolean

If set to false, will create smart wallets for new users only.

accountAbstraction.separateSmartWalletAndSigner

boolean

if set to false, only smart wallet will be in user wallets list.

accountAbstraction.enablePasskeys

boolean

If set to false, will disable passkeys (if specified) for zksync wallets.

blockEmailSubaddresses

boolean

enableMultiAsset

boolean

showFiat

boolean

disabledWalletConnectors

string[]

Ids of wallet connectors to filter out from available options in the sdk

Required string length: 2 - 50

funding

object

Show child attributes

funding.onramps

enum<string>[]

required

Available options:

banxa,

coinbaseOnramp,

cryptoDotCom

funding.externalWallets

object

Show child attributes

funding.externalWallets.enabled

boolean

required

funding.externalWallets.minAmount

object

Show child attributes

funding.externalWallets.minAmount.amount

string

funding.externalWallets.minAmount.currency

string

funding.externalWallets.defaultSettings

object

Show child attributes

funding.externalWallets.defaultSettings.chainSettings

object[]

Show child attributes

funding.externalWallets.defaultSettings.chainSettings.chain

enum<string>

Available options:

ETH,

EVM,

FLOW,

SOL,

ALGO,

STARK,

COSMOS,

BTC,

ECLIPSE,

SUI,

SPARK,

TRON,

APTOS,

TON

funding.externalWallets.defaultSettings.chainSettings.token

object

Show child attributes

funding.externalWallets.defaultSettings.chainSettings.token.value

string

funding.externalWallets.defaultSettings.chainSettings.token.rule

enum<string>

Available options:

recommended,

exact

{ "nameService": { "evm": { "domain": "<string>" } }, "featureFlags": { "connectOnlyMultiAsset": true, "enableExchanges": true }, "emailSignIn": { "signInProvider": "dynamic" }, "socialSignIn": { "signInProvider": "dynamic", "providers": [ { "provider": "apple", "enabled": true } ] }, "exchangeOptions": [ { "exchange": "coinbase", "socialProvider": "emailOnly", "onRampProvider": "emailOnly" } ], "multiWallet": true, "multiWalletUnlinkDisabled": true, "mobile": { "deeplinkUrlsEnabled": true }, "confirmWalletTransfers": true, "onrampFunding": true, "passkeyEmbeddedWalletEnabled": true, "automaticEmbeddedWalletCreation": true, "passkeyEmbeddedWalletRecoveryEnabled": true, "embeddedWalletSecurityMethods": [ "passkey" ], "embeddedWallets": { "automaticEmbeddedWalletCreation": true, "automaticEmbeddedWalletCreationForExternal": true, "showEmbeddedWalletActionsUI": true, "emailRecoveryEnabled": true, "forceAuthenticatorAtSignup": true, "allowSkippingAuthenticatorAtSignup": true, "sessionKeyDuration": { "amount": 123, "unit": "days" }, "supportedSecurityMethods": { "passkey": { "isDefault": true, "isEnabled": true, "isPermanentAuthenticator": true, "listPosition": 123 }, "email": { "isDefault": true, "isEnabled": true, "isPermanentAuthenticator": true, "listPosition": 123 }, "password": { "isDefault": true, "isEnabled": true, "isPermanentAuthenticator": true, "listPosition": 123 } }, "chainConfigurations": [ { "name": "<string>", "enabled": true, "primary": true } ], "domainEnabledByProvider": true, "defaultWalletVersion": "V1", "promptForKeyExport": true, "transactionSimulation": true }, "waas": { "passcodeRequired": true, "onSignUp": { "promptBackupOptions": true, "promptClientShareExport": true }, "backupOptions": [ "googleDrive" ], "allowMultipleWaasWalletsPerChain": true, "relayUrl": "<string>", "delegatedAccessEndpoint": "<string>", "delegatedAccess": { "enabled": true, "promptUsersOnSignIn": true, "requiresDelegation": true }, "enableForwardMPCClient": true }, "walletConnect": { "projectId": "<string>", "v2Enabled": true, "walletProjectId": "<string>" }, "confirmEmailProviderForVerify": true, "displayDynamicMessaging": true, "hideNetworkInDynamicWidget": true, "preventOrphanedAccounts": true, "views": [ { "type": "login", "sections": [ { "type": "email", "label": "<string>", "numOfItemsToDisplay": 123, "defaultItem": "<string>", "alignment": "center" } ] } ], "accountAbstraction": { "allWallets": true, "allUsers": true, "separateSmartWalletAndSigner": true, "enablePasskeys": true }, "blockEmailSubaddresses": true, "enableMultiAsset": true, "showFiat": true, "disabledWalletConnectors": [ "metamask" ], "funding": { "onramps": [ "banxa" ], "externalWallets": { "enabled": true, "minAmount": { "amount": "<string>", "currency": "<string>" }, "defaultSettings": { "chainSettings": [ { "chain": "ETH", "token": { "value": "<string>", "rule": "recommended" } } ] } } } }

Allowlists

GlobalWallets

GlobalWalletAccessControl

NameServices

TestAccount

CustomHostnames

DeeplinkUrls

Exports

Gates

Settings

Analytics

Organizations

Projects

Custom Networks

Chainalysis

Chains

Environments

Sessions

Wallets

Users

Visits

Members

MfaSettings

Invites

ExternalJwt

Origins

UserApiTokens

Tokens

Allowlists

Chains

SDK Views

Events

Webhooks

SDK

Custom Fields

DeeplinkUrls

Mfa

Waas

Schemas

ProjectSettingsSdk