EnvironmentsResponse

environments

object

required

environments.live

object

required

environments.live.id

string

required

environments.live.settings

object

environments.live.settings.environmentName

enum<string>

Available options:

sandbox,

live

environments.live.settings.chains

object[]

required

environments.live.settings.customFields

object[]

environments.live.settings.kyc

object[]

required

environments.live.settings.design

object

required

environments.live.settings.general

object

required

environments.live.settings.privacy

object

required

environments.live.settings.providers

object[]

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

environments.live.settings.providers.id

string

environments.live.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

environments.live.settings.providers.enabledAt

string | null

environments.live.settings.providers.clientId

string

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

environments.live.settings.providers.clientSecret

string

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

environments.live.settings.providers.providerProjectId

string

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

environments.live.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

environments.live.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

environments.live.settings.providers.defaultChainId

integer

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

environments.live.settings.providers.defaultChain

string

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

environments.live.settings.providers.keyExportUrl

string

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

environments.live.settings.providers.termsAcceptedByUser

object

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

environments.live.settings.providers.appleKeyId

string

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

environments.live.settings.providers.appleTeamId

string

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

environments.live.settings.providers.accountSid

string

Required to initialize Twilio provider.

environments.live.settings.providers.twilioNumber

string

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

environments.live.settings.providers.enabledCountries

object[]

environments.live.settings.providers.entryPointVersion

enum<string>

Available options:

v6,

v7

environments.live.settings.providers.kernelVersion

enum<string>

Available options:

v2_4,

v3_0,

v3_1

environments.live.settings.providers.ecdsaProviderType

enum<string>

Available options:

zerodev_signer_to_ecdsa,

zerodev_multi_chain

environments.live.settings.sdk

object

required

environments.live.settings.sdk.emailSignIn

object

environments.live.settings.sdk.socialSignIn

object

environments.live.settings.sdk.multiWallet

boolean

environments.live.settings.sdk.multiWalletUnlinkDisabled

boolean

environments.live.settings.sdk.mobile

object

environments.live.settings.sdk.confirmWalletTransfers

boolean

environments.live.settings.sdk.onrampFunding

boolean

environments.live.settings.sdk.passkeyEmbeddedWalletEnabled

boolean

deprecated

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

environments.live.settings.sdk.automaticEmbeddedWalletCreation

boolean

environments.live.settings.sdk.passkeyEmbeddedWalletRecoveryEnabled

boolean

environments.live.settings.sdk.embeddedWalletSecurityMethods

enum<string>[]

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

Available options:

passkey,

passphrase

environments.live.settings.sdk.embeddedWallets

object

environments.live.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.

environments.live.settings.sdk.embeddedWallets.showEmbeddedWalletActionsUI

boolean

When true users will see embedded wallets action confirmation views.

environments.live.settings.sdk.embeddedWallets.emailRecoveryEnabled

boolean

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

environments.live.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

environments.live.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.

environments.live.settings.sdk.embeddedWallets.sessionKeyDuration

object

environments.live.settings.sdk.embeddedWallets.supportedSecurityMethods

object

environments.live.settings.sdk.embeddedWallets.chainConfigurations

object[]

Chain specific configuration for dynamic embedded wallets

environments.live.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.

environments.live.settings.sdk.walletConnect

object

environments.live.settings.sdk.confirmEmailProviderForVerify

boolean

environments.live.settings.sdk.displayDynamicMessaging

boolean

environments.live.settings.sdk.hideNetworkInDynamicWidget

boolean

environments.live.settings.sdk.preventOrphanedAccounts

boolean

environments.live.settings.sdk.views

object[]

Configs used to create the views in the sdk.

environments.live.settings.sdk.accountAbstraction

object

environments.live.settings.sdk.enableMultiAsset

boolean

environments.live.settings.sdk.showFiat

boolean

environments.live.settings.security

object

required

environments.live.settings.networks

object[]

environments.live.createdAt

string

environments.live.updatedAt

string

environments.live.sdkVersion

string

environments.sandbox

object

required

environments.sandbox.id

string

required

environments.sandbox.settings

object

environments.sandbox.settings.environmentName

enum<string>

Available options:

sandbox,

live

environments.sandbox.settings.chains

object[]

required

environments.sandbox.settings.customFields

object[]

environments.sandbox.settings.kyc

object[]

required

environments.sandbox.settings.design

object

required

environments.sandbox.settings.general

object

required

environments.sandbox.settings.privacy

object

required

environments.sandbox.settings.providers

object[]

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

environments.sandbox.settings.providers.id

string

environments.sandbox.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

environments.sandbox.settings.providers.enabledAt

string | null

environments.sandbox.settings.providers.clientId

string

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

environments.sandbox.settings.providers.clientSecret

string

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

environments.sandbox.settings.providers.providerProjectId

string

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

environments.sandbox.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

environments.sandbox.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

environments.sandbox.settings.providers.defaultChainId

integer

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

environments.sandbox.settings.providers.defaultChain

string

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

environments.sandbox.settings.providers.keyExportUrl

string

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

environments.sandbox.settings.providers.termsAcceptedByUser

object

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

environments.sandbox.settings.providers.appleKeyId

string

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

environments.sandbox.settings.providers.appleTeamId

string

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

environments.sandbox.settings.providers.accountSid

string

Required to initialize Twilio provider.

environments.sandbox.settings.providers.twilioNumber

string

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

environments.sandbox.settings.providers.enabledCountries

object[]

environments.sandbox.settings.providers.entryPointVersion

enum<string>

Available options:

v6,

v7

environments.sandbox.settings.providers.kernelVersion

enum<string>

Available options:

v2_4,

v3_0,

v3_1

environments.sandbox.settings.providers.ecdsaProviderType

enum<string>

Available options:

zerodev_signer_to_ecdsa,

zerodev_multi_chain

environments.sandbox.settings.sdk

object

required

environments.sandbox.settings.sdk.emailSignIn

object

environments.sandbox.settings.sdk.socialSignIn

object

environments.sandbox.settings.sdk.multiWallet

boolean

environments.sandbox.settings.sdk.multiWalletUnlinkDisabled

boolean

environments.sandbox.settings.sdk.mobile

object

environments.sandbox.settings.sdk.confirmWalletTransfers

boolean

environments.sandbox.settings.sdk.onrampFunding

boolean

environments.sandbox.settings.sdk.passkeyEmbeddedWalletEnabled

boolean

deprecated

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

environments.sandbox.settings.sdk.automaticEmbeddedWalletCreation

boolean

environments.sandbox.settings.sdk.passkeyEmbeddedWalletRecoveryEnabled

boolean

environments.sandbox.settings.sdk.embeddedWalletSecurityMethods

enum<string>[]

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

Available options:

passkey,

passphrase

environments.sandbox.settings.sdk.embeddedWallets

object

environments.sandbox.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.

environments.sandbox.settings.sdk.embeddedWallets.showEmbeddedWalletActionsUI

boolean

When true users will see embedded wallets action confirmation views.

environments.sandbox.settings.sdk.embeddedWallets.emailRecoveryEnabled

boolean

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

environments.sandbox.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

environments.sandbox.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.

environments.sandbox.settings.sdk.embeddedWallets.sessionKeyDuration

object

environments.sandbox.settings.sdk.embeddedWallets.supportedSecurityMethods

object

environments.sandbox.settings.sdk.embeddedWallets.chainConfigurations

object[]

Chain specific configuration for dynamic embedded wallets

environments.sandbox.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.

environments.sandbox.settings.sdk.walletConnect

object

environments.sandbox.settings.sdk.confirmEmailProviderForVerify

boolean

environments.sandbox.settings.sdk.displayDynamicMessaging

boolean

environments.sandbox.settings.sdk.hideNetworkInDynamicWidget

boolean

environments.sandbox.settings.sdk.preventOrphanedAccounts

boolean

environments.sandbox.settings.sdk.views

object[]

Configs used to create the views in the sdk.

environments.sandbox.settings.sdk.accountAbstraction

object

environments.sandbox.settings.sdk.enableMultiAsset

boolean

environments.sandbox.settings.sdk.showFiat

boolean

environments.sandbox.settings.security

object

required

environments.sandbox.settings.networks

object[]

environments.sandbox.createdAt

string

environments.sandbox.updatedAt

string

environments.sandbox.sdkVersion

string

Was this page helpful?

EnvironmentVisitorsResponse ErrorMessageWithCode

Rest API