ProjectEnvironment

string

required

settings

object

settings.environmentName

enum<string>

Available options:

sandbox,

live

settings.chains

object[]

required

settings.customFields

object[]

settings.kyc

object[]

required

settings.design

object

required

settings.general

object

required

settings.privacy

object

required

settings.providers

object[]

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

settings.providers.id

string

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

settings.providers.enabledAt

string | null

settings.providers.clientId

string

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

settings.providers.clientSecret

string

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

settings.providers.providerProjectId

string

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

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

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

settings.providers.defaultChainId

integer

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

settings.providers.defaultChain

string

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

settings.providers.keyExportUrl

string

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

settings.providers.termsAcceptedByUser

object

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

settings.providers.appleKeyId

string

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

settings.providers.appleTeamId

string

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

settings.providers.accountSid

string

Required to initialize Twilio provider.

settings.providers.twilioNumber

string

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

settings.providers.enabledCountries

object[]

settings.providers.entryPointVersion

enum<string>

Available options:

v6,

v7

settings.providers.kernelVersion

enum<string>

Available options:

v2_4,

v3_0,

v3_1

settings.providers.ecdsaProviderType

enum<string>

Available options:

zerodev_signer_to_ecdsa,

zerodev_multi_chain

settings.sdk

object

required

settings.sdk.emailSignIn

object

settings.sdk.socialSignIn

object

settings.sdk.multiWallet

boolean

settings.sdk.multiWalletUnlinkDisabled

boolean

settings.sdk.mobile

object

settings.sdk.confirmWalletTransfers

boolean

settings.sdk.onrampFunding

boolean

settings.sdk.passkeyEmbeddedWalletEnabled

boolean

deprecated

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

settings.sdk.automaticEmbeddedWalletCreation

boolean

settings.sdk.passkeyEmbeddedWalletRecoveryEnabled

boolean

settings.sdk.embeddedWalletSecurityMethods

enum<string>[]

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

Available options:

passkey,

passphrase

settings.sdk.embeddedWallets

object

settings.sdk.embeddedWallets.automaticEmbeddedWalletCreation

boolean

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

settings.sdk.embeddedWallets.showEmbeddedWalletActionsUI

boolean

When true users will see embedded wallets action confirmation views.

settings.sdk.embeddedWallets.emailRecoveryEnabled

boolean

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

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

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

settings.sdk.embeddedWallets.sessionKeyDuration

object

settings.sdk.embeddedWallets.supportedSecurityMethods

object

settings.sdk.embeddedWallets.chainConfigurations

object[]

Chain specific configuration for dynamic embedded wallets

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

settings.sdk.walletConnect

object

settings.sdk.confirmEmailProviderForVerify

boolean

settings.sdk.displayDynamicMessaging

boolean

settings.sdk.hideNetworkInDynamicWidget

boolean

settings.sdk.preventOrphanedAccounts

boolean

settings.sdk.views

object[]

Configs used to create the views in the sdk.

settings.sdk.accountAbstraction

object

settings.sdk.enableMultiAsset

boolean

settings.sdk.showFiat

boolean

settings.security

object

required

settings.networks

object[]

createdAt

string

updatedAt

string

sdkVersion

string

Was this page helpful?

Project ProjectRequest

Rest API