ProjectSettings

environmentName

enum<string>

Available options:

sandbox,

live

chains

object[]

required

customFields

object[]

kyc

object[]

required

design

object

required

general

object

required

privacy

object

required

providers

object[]

External integrations like e-mail, social credentials, mpc providers, etc.

providers.id

string

providers.provider

enum<string>

required

Available options:

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

providers.enabledAt

string | null

providers.clientId

string

Standard OAuth client ID. For more information, see: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/

providers.clientSecret

string

Standard OAuth client secret key. For more information, see: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/

providers.providerProjectId

string

Some providers require additional information, typically called a project ID or site ID

providers.authorizationUrl

string

If the provider supports Oauth 2, this field will contain the URL of the login and authorization where a user can authorize the applciation to gain access to their provider account

providers.redirectUrl

string

If the provider supports Oauth 2, this field will contain the URL of redirect or callback URL which will need to be provided to the Oauth provider to properly configure your App tp talk with Dynamic

providers.defaultChainId

integer

DEPRECATED: Use defaultChain. The default chain id the SDK should use

providers.defaultChain

string

CAIP-2 Chain ID (https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-2.md)

providers.keyExportUrl

string

The url of the site to go to export wallets private keys

providers.termsAcceptedByUser

object

Reference to the user that accepted the terms and conditions, if one is necessary for this provider.

providers.appleKeyId

string

Key ID required for Apple Oauth2 applications. This is the identifier for a private key.

providers.appleTeamId

string

Team ID required for Apple Oauth2 applications. This is associated with the Apple developer membership account.

providers.accountSid

string

Required to initialize Twilio provider.

providers.twilioNumber

string

Required to initialize Twilio provider. Phone number used to send SMS messages.

providers.enabledCountries

object[]

providers.entryPointVersion

enum<string>

Available options:

v6,

v7

providers.kernelVersion

enum<string>

Available options:

v2_4,

v3_0,

v3_1

providers.ecdsaProviderType

enum<string>

Available options:

zerodev_signer_to_ecdsa,

zerodev_multi_chain

sdk

object

required

sdk.emailSignIn

object

sdk.socialSignIn

object

sdk.multiWallet

boolean

sdk.multiWalletUnlinkDisabled

boolean

sdk.mobile

object

sdk.confirmWalletTransfers

boolean

sdk.onrampFunding

boolean

sdk.passkeyEmbeddedWalletEnabled

boolean

deprecated

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

sdk.automaticEmbeddedWalletCreation

boolean

sdk.passkeyEmbeddedWalletRecoveryEnabled

boolean

sdk.embeddedWalletSecurityMethods

enum<string>[]

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

Available options:

passkey,

passphrase

sdk.embeddedWallets

object

sdk.embeddedWallets.automaticEmbeddedWalletCreation

boolean

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

sdk.embeddedWallets.showEmbeddedWalletActionsUI

boolean

When true users will see embedded wallets action confirmation views.

sdk.embeddedWallets.emailRecoveryEnabled

boolean

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

sdk.embeddedWallets.forceAuthenticatorAtSignup

boolean

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

sdk.embeddedWallets.allowSkippingAuthenticatorAtSignup

boolean

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

sdk.embeddedWallets.sessionKeyDuration

object

sdk.embeddedWallets.supportedSecurityMethods

object

sdk.embeddedWallets.chainConfigurations

object[]

Chain specific configuration for dynamic embedded wallets

sdk.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.

sdk.walletConnect

object

sdk.confirmEmailProviderForVerify

boolean

sdk.displayDynamicMessaging

boolean

sdk.hideNetworkInDynamicWidget

boolean

sdk.preventOrphanedAccounts

boolean

sdk.views

object[]

Configs used to create the views in the sdk.

sdk.accountAbstraction

object

sdk.enableMultiAsset

boolean

sdk.showFiat

boolean

security

object

required

networks

object[]

Rest API