curl --request GET \
--url https://app.dynamicauth.com/api/v0/environments/{environmentId} \
--header 'Authorization: Bearer <token>'{
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"settings": {
"chains": [
{
"name": "<string>",
"enabled": true,
"networks": [
{
"networkId": "1",
"chainName": "Ethereum Mainnet",
"enabled": true,
"rpcUrl": "<string>",
"iconUrl": "<string>",
"type": "custom"
}
]
}
],
"kyc": [
{
"name": "<string>",
"required": true,
"enabled": true,
"unique": true,
"verify": true,
"type": "standard",
"validationRules": {
"unique": true,
"regex": "^0x",
"validOptions": [
{
"label": "small"
},
{
"label": "medium"
},
{
"label": "large"
}
],
"checkboxText": "Agree to the terms and conditions"
},
"validationType": "text",
"label": "<string>",
"position": 123
}
],
"design": {
"modal": {
"border": "<string>",
"brand": "<string>",
"primaryColor": "<string>",
"radius": 123,
"theme": "<string>",
"view": "<string>",
"template": "<string>",
"displayOrder": [
"<string>"
],
"emailOnly": true,
"showWalletsButton": true,
"emailSubmitButtonInsideInput": true,
"splitEmailAndSocial": true,
"socialAboveEmail": true
},
"button": {
"background": "<string>",
"fontColor": "<string>",
"paddingHeight": 123,
"paddingWidth": 123,
"radius": 123
},
"widget": {
"backgroundColor": "<string>",
"border": "<string>",
"radius": 123,
"textColor": "<string>",
"theme": "<string>"
}
},
"general": {
"displayName": "An example name",
"supportEmail": "jsmith@example.com",
"supportText": "<string>",
"appLogo": "<string>",
"imageUserNotInAccessList": "<string>",
"imageUserInAccessList": "<string>",
"supportUrls": {
"slack": "https://dynamic.xyz",
"twitter": "https://dynamic.xyz"
},
"collectUserDataWelcomeHeader": "<string>",
"collectUserDataWelcomeMessage": "<string>",
"skipOptionalKYCFieldDuringOnboarding": true,
"emailCompanyName": "An example name"
},
"privacy": {
"collectIp": true
},
"sdk": {
"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,
"customKeyshareRelayBaseUrl": "<string>"
},
"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"
}
}
]
}
}
}
},
"security": {
"jwtDuration": {
"amount": 123,
"unit": "days"
},
"hCaptcha": {
"enabled": true,
"secretKey": "<string>",
"siteKey": "<string>"
},
"mfa": {
"enabled": true,
"required": true,
"availableMethods": [
"totp"
],
"methods": [
{
"type": "totp",
"enabled": true,
"allowBackupCodes": true
}
],
"actions": [
{
"action": "wallet.waas.sign",
"required": true
}
]
},
"auth": {
"storage": [
"localstorage"
]
},
"externalAuth": {
"enabled": true,
"iss": "An example name",
"aud": "An example name",
"jwksUrl": "<string>",
"cookieName": "An example name"
}
},
"environmentName": "sandbox",
"customFields": [
{
"name": "<string>",
"required": true,
"enabled": true,
"unique": true,
"verify": true,
"type": "standard",
"validationRules": {
"unique": true,
"regex": "^0x",
"validOptions": [
{
"label": "small"
},
{
"label": "medium"
},
{
"label": "large"
}
],
"checkboxText": "Agree to the terms and conditions"
},
"validationType": "text",
"label": "<string>",
"position": 123
}
],
"providers": [
{
"provider": "emailOnly",
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"enabledAt": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"clientSecret": "<string>",
"providerProjectId": "<string>",
"authorizationUrl": "<string>",
"redirectUrl": "<string>",
"defaultChainId": 123,
"defaultChain": "eip155:1",
"keyExportUrl": "<string>",
"termsAcceptedByUser": {
"termsUrl": "<string>",
"email": "jsmith@example.com",
"userId": "95b11417-f18f-457f-8804-68e361f9164f",
"createdAt": "2023-11-07T05:31:56Z"
},
"scopes": "<string>",
"baseAuthUrl": "<string>",
"appleKeyId": "<string>",
"appleTeamId": "<string>",
"shopifyStore": "<string>",
"domain": "<string>",
"accountSid": "<string>",
"twilioNumber": "<string>",
"enabledCountries": [
{
"isoCountryCode": "US",
"phoneCountryCode": "An example name"
}
],
"sendgridIpPoolName": "<string>",
"entryPointVersion": "v6",
"kernelVersion": "v2_4",
"factoryAddress": "<string>",
"paymasterAddress": "<string>",
"passkeyAddress": "<string>",
"sessionAddress": "<string>",
"salt": "<string>",
"multichainAccountAbstractionProviders": [
{
"clientId": "<string>",
"chain": "<string>",
"default": true
}
],
"ecdsaProviderType": "zerodev_signer_to_ecdsa",
"createNewAccounts": true,
"enableKernelV3Migration": true,
"enableEIP7702": true,
"zerodevBundlerProvider": "STACKUP",
"zerodevBundlerRpcUrl": "<string>",
"zerodevPaymasterRpcUrl": "<string>",
"zerodevKernelDelegationAddress": "<string>",
"returnUrl": "<string>",
"cancelUrl": "<string>"
}
],
"exchanges": [
{
"exchange": "coinbase",
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"enabledAt": "2023-11-07T05:31:56Z",
"socialProvider": "emailOnly",
"onRampProvider": "emailOnly"
}
],
"networks": [
{
"chainName": "<string>",
"networks": [
{
"name": "Ethereum Mainnet",
"shortName": "ETH",
"chain": "ETH",
"chainId": "1",
"networkId": "1",
"iconUrls": [
"<string>"
],
"nativeCurrency": {
"decimals": "18",
"name": "Ether",
"symbol": "ETH",
"denom": "uatom",
"iconUrl": "<string>",
"pricingProviderTokenId": "<string>"
},
"rpcUrls": [
"https://mainnet.infura.io/v3/"
],
"blockExplorerUrls": [
"https://etherscan.io/"
],
"lcdUrl": "https://lcd.osmosis.zone",
"chainName": "Ethereum Mainnet",
"key": "ethereum",
"isTestnet": false,
"nameService": {
"registry": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e"
},
"privateCustomerRpcUrls": [
"https://mainnet.infura.io/v3/"
],
"vanityName": "Ethereum",
"bech32Prefix": "cosmos",
"genesisHash": "5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
"cluster": "mainnet, devnet, etc"
}
]
}
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"sdkVersion": "<string>"
}curl --request GET \
--url https://app.dynamicauth.com/api/v0/environments/{environmentId} \
--header 'Authorization: Bearer <token>'{
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"settings": {
"chains": [
{
"name": "<string>",
"enabled": true,
"networks": [
{
"networkId": "1",
"chainName": "Ethereum Mainnet",
"enabled": true,
"rpcUrl": "<string>",
"iconUrl": "<string>",
"type": "custom"
}
]
}
],
"kyc": [
{
"name": "<string>",
"required": true,
"enabled": true,
"unique": true,
"verify": true,
"type": "standard",
"validationRules": {
"unique": true,
"regex": "^0x",
"validOptions": [
{
"label": "small"
},
{
"label": "medium"
},
{
"label": "large"
}
],
"checkboxText": "Agree to the terms and conditions"
},
"validationType": "text",
"label": "<string>",
"position": 123
}
],
"design": {
"modal": {
"border": "<string>",
"brand": "<string>",
"primaryColor": "<string>",
"radius": 123,
"theme": "<string>",
"view": "<string>",
"template": "<string>",
"displayOrder": [
"<string>"
],
"emailOnly": true,
"showWalletsButton": true,
"emailSubmitButtonInsideInput": true,
"splitEmailAndSocial": true,
"socialAboveEmail": true
},
"button": {
"background": "<string>",
"fontColor": "<string>",
"paddingHeight": 123,
"paddingWidth": 123,
"radius": 123
},
"widget": {
"backgroundColor": "<string>",
"border": "<string>",
"radius": 123,
"textColor": "<string>",
"theme": "<string>"
}
},
"general": {
"displayName": "An example name",
"supportEmail": "jsmith@example.com",
"supportText": "<string>",
"appLogo": "<string>",
"imageUserNotInAccessList": "<string>",
"imageUserInAccessList": "<string>",
"supportUrls": {
"slack": "https://dynamic.xyz",
"twitter": "https://dynamic.xyz"
},
"collectUserDataWelcomeHeader": "<string>",
"collectUserDataWelcomeMessage": "<string>",
"skipOptionalKYCFieldDuringOnboarding": true,
"emailCompanyName": "An example name"
},
"privacy": {
"collectIp": true
},
"sdk": {
"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,
"customKeyshareRelayBaseUrl": "<string>"
},
"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"
}
}
]
}
}
}
},
"security": {
"jwtDuration": {
"amount": 123,
"unit": "days"
},
"hCaptcha": {
"enabled": true,
"secretKey": "<string>",
"siteKey": "<string>"
},
"mfa": {
"enabled": true,
"required": true,
"availableMethods": [
"totp"
],
"methods": [
{
"type": "totp",
"enabled": true,
"allowBackupCodes": true
}
],
"actions": [
{
"action": "wallet.waas.sign",
"required": true
}
]
},
"auth": {
"storage": [
"localstorage"
]
},
"externalAuth": {
"enabled": true,
"iss": "An example name",
"aud": "An example name",
"jwksUrl": "<string>",
"cookieName": "An example name"
}
},
"environmentName": "sandbox",
"customFields": [
{
"name": "<string>",
"required": true,
"enabled": true,
"unique": true,
"verify": true,
"type": "standard",
"validationRules": {
"unique": true,
"regex": "^0x",
"validOptions": [
{
"label": "small"
},
{
"label": "medium"
},
{
"label": "large"
}
],
"checkboxText": "Agree to the terms and conditions"
},
"validationType": "text",
"label": "<string>",
"position": 123
}
],
"providers": [
{
"provider": "emailOnly",
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"enabledAt": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"clientSecret": "<string>",
"providerProjectId": "<string>",
"authorizationUrl": "<string>",
"redirectUrl": "<string>",
"defaultChainId": 123,
"defaultChain": "eip155:1",
"keyExportUrl": "<string>",
"termsAcceptedByUser": {
"termsUrl": "<string>",
"email": "jsmith@example.com",
"userId": "95b11417-f18f-457f-8804-68e361f9164f",
"createdAt": "2023-11-07T05:31:56Z"
},
"scopes": "<string>",
"baseAuthUrl": "<string>",
"appleKeyId": "<string>",
"appleTeamId": "<string>",
"shopifyStore": "<string>",
"domain": "<string>",
"accountSid": "<string>",
"twilioNumber": "<string>",
"enabledCountries": [
{
"isoCountryCode": "US",
"phoneCountryCode": "An example name"
}
],
"sendgridIpPoolName": "<string>",
"entryPointVersion": "v6",
"kernelVersion": "v2_4",
"factoryAddress": "<string>",
"paymasterAddress": "<string>",
"passkeyAddress": "<string>",
"sessionAddress": "<string>",
"salt": "<string>",
"multichainAccountAbstractionProviders": [
{
"clientId": "<string>",
"chain": "<string>",
"default": true
}
],
"ecdsaProviderType": "zerodev_signer_to_ecdsa",
"createNewAccounts": true,
"enableKernelV3Migration": true,
"enableEIP7702": true,
"zerodevBundlerProvider": "STACKUP",
"zerodevBundlerRpcUrl": "<string>",
"zerodevPaymasterRpcUrl": "<string>",
"zerodevKernelDelegationAddress": "<string>",
"returnUrl": "<string>",
"cancelUrl": "<string>"
}
],
"exchanges": [
{
"exchange": "coinbase",
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"enabledAt": "2023-11-07T05:31:56Z",
"socialProvider": "emailOnly",
"onRampProvider": "emailOnly"
}
],
"networks": [
{
"chainName": "<string>",
"networks": [
{
"name": "Ethereum Mainnet",
"shortName": "ETH",
"chain": "ETH",
"chainId": "1",
"networkId": "1",
"iconUrls": [
"<string>"
],
"nativeCurrency": {
"decimals": "18",
"name": "Ether",
"symbol": "ETH",
"denom": "uatom",
"iconUrl": "<string>",
"pricingProviderTokenId": "<string>"
},
"rpcUrls": [
"https://mainnet.infura.io/v3/"
],
"blockExplorerUrls": [
"https://etherscan.io/"
],
"lcdUrl": "https://lcd.osmosis.zone",
"chainName": "Ethereum Mainnet",
"key": "ethereum",
"isTestnet": false,
"nameService": {
"registry": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e"
},
"privateCustomerRpcUrls": [
"https://mainnet.infura.io/v3/"
],
"vanityName": "Ethereum",
"bech32Prefix": "cosmos",
"genesisHash": "5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
"cluster": "mainnet, devnet, etc"
}
]
}
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"sdkVersion": "<string>"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ID of the environment
36"95b11417-f18f-457f-8804-68e361f9164f"
Environment response
36"95b11417-f18f-457f-8804-68e361f9164f"
Show child attributes
Show child attributes
Show child attributes
"1"
"Ethereum Mainnet"
custom, default Show child attributes
standard, custom Optional validation rules for the custom field
Show child attributes
If this field must be unique for every user in the environment
The regex pattern that the text field must match
255"^0x"
The dropdown options for the select field
[
{ "label": "small" },
{ "label": "medium" },
{ "label": "large" }
]The text that will be displayed for the checkbox field
255"Agree to the terms and conditions"
text, checkbox, select Show child attributes
Show child attributes
Show child attributes
"An example name"
255255255100"An example name"
Show child attributes
Show child attributes
The 'turnkey' value is deprecated and will be removed in a future version.
dynamic, magicLink, blocto, turnkey, coinbaseWaas Show child attributes
apple, bitbucket, coinbasesocial, discord, epicgames, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, telegram, spotify, tiktok, line, steam, shopify, kraken, okta Show child attributes
Source exchange identifier
coinbase, kraken The 'turnkey' value is deprecated and will be removed in a future version.
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 The 'turnkey' value is deprecated and will be removed in a future version.
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 passkeyEmbeddedWalletEnabled is deprecated as of v0.19. Please enable embedded wallets using the provider API.
Embedded wallet authenticator security methods required upon creation of the embedded wallet at onboarding
passkey, passphrase Show child attributes
When true embedded wallets will be generated during onboarding for the users. When false customer needs to trigger the creation.
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.
When true users will see embedded wallets action confirmation views.
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.
V1, V2, V3 When true, the user will be prompted to export their private key after creating a wallet.
When true, user transactions will show asset transfers in the Confirmation UI.
Show child attributes
When true, passcode security method is forced for v3 embedded wallets. Usually it is an optional security method.
googleDrive, icloud, dynamic, external, delegated When true, users can have multiple WAAS wallets per chain.
The URL of the relay server for the environment. If not provided, the default relay server will be used.
The URL of the delegated access endpoint for WAAS. If not provided, no delegated access endpoint will be used.
Show child attributes
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.
If enabled, users will be required to delegate access.
When true, the sdk will utilize the forward MPC client for select MPC operations.
When applicable, this is the custom base URL hostname to use for the WAAS keyshare backup relay. If not provided, the default will be used.
Configs used to create the views in the sdk.
Show child attributes
login 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
email, emailAndPhone, phone, separator, social, text, wallet, passkey 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.
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.
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.
center, left, right Show child attributes
If set to false, will create smart wallets for embedded wallets only.
If set to false, will create smart wallets for new users only.
if set to false, only smart wallet will be in user wallets list.
If set to false, will disable passkeys (if specified) for zksync wallets.
Ids of wallet connectors to filter out from available options in the sdk
2 - 50Show child attributes
banxa, coinbaseOnramp, cryptoDotCom Show child attributes
Show child attributes
Show child attributes
ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC, ECLIPSE, SUI, SPARK, TRON, APTOS, TON Show child attributes
Show child attributes
totp, passkey, email Show child attributes
255"An example name"
255"An example name"
255"An example name"
sandbox, live Show child attributes
standard, custom Optional validation rules for the custom field
Show child attributes
If this field must be unique for every user in the environment
The regex pattern that the text field must match
255"^0x"
The dropdown options for the select field
[
{ "label": "small" },
{ "label": "medium" },
{ "label": "large" }
]The text that will be displayed for the checkbox field
255"Agree to the terms and conditions"
text, checkbox, select External integrations like e-mail, social credentials, mpc providers, etc.
Show child attributes
The 'turnkey' value is deprecated and will be removed in a future version.
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 36"95b11417-f18f-457f-8804-68e361f9164f"
Standard OAuth client ID. For more information, see: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/
Standard OAuth client secret key. For more information, see: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/
Some providers require additional information, typically called a project ID or site ID
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
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
DEPRECATED: Use defaultChain. The default chain id the SDK should use
CAIP-2 Chain ID (https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-2.md)
5 - 41"eip155:1"
The url of the site to go to export wallets private keys
Reference to the user that accepted the terms and conditions, if one is necessary for this provider.
Show child attributes
The url of the terms and conditions or privacy policy needed to be shown to the client when creating a new provider that requires terms and conditions to be signed before starting configuration.
25525536"95b11417-f18f-457f-8804-68e361f9164f"
Optional custom space-delimited list of Oauth scopes for the social provider
Base auth url for oauth provider
Key ID required for Apple Oauth2 applications. This is the identifier for a private key.
Team ID required for Apple Oauth2 applications. This is associated with the Apple developer membership account.
Shopify store required for Shopify Oauth2 applications.
The subdomain for the provider (mostly used for SSO)
Required to initialize Twilio provider.
Required to initialize Twilio provider. Phone number used to send SMS messages.
The IP pool name for the SendGrid provider.
v6, v7 v2_4, v3_0, v3_1, v3_2, v3_3 The factory address for the provider (currently only used for zksync)
The paymaster address for the provider (currently only used for zksync)
The passkey address for the provider (currently only used for zksync)
The session address for the provider (currently only used for zksync)
The salt for the provider address generation (currently only used for zksync)
zerodev_signer_to_ecdsa, zerodev_multi_chain STACKUP, PIMLICO, ALCHEMY, GELATO URL to return to after completion
URL to return to when cancelled
exchanges such as coinbase, binance, etc
Show child attributes
Source exchange identifier
coinbase, kraken 36"95b11417-f18f-457f-8804-68e361f9164f"
The 'turnkey' value is deprecated and will be removed in a future version.
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 The 'turnkey' value is deprecated and will be removed in a future version.
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 Show child attributes
Show child attributes
"Ethereum Mainnet"
"ETH"
"ETH"
"1"
"1"
Show child attributes
"18"
"Ether"
"ETH"
"uatom"
A light client, compared to a full node, tracks only pieces of certain information on a blockchain. Light clients do not track the entire state of a blockchain and also do not contain every transaction/block of a chain.
"https://lcd.osmosis.zone"
[Deprecated] use name property instead
"Ethereum Mainnet"
"ethereum"
false
Contains the client private RPC urls
"Ethereum"
"cosmos"
"5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp"
"mainnet, devnet, etc"
Was this page helpful?