ProjectSettings

chains
object[]
required
Show child attributes
kyc
object[]
required
Show child attributes
design
object
required
Show child attributes
general
object
required
Show child attributes
privacy
object
required
Show child attributes
sdk
object
required
Show child attributes
security
object
required
Show child attributes
environmentName
enum<string>
Available options:
sandbox,
live
customFields
object[]
Show child attributes
providers
object[]
External integrations like e-mail, social credentials, mpc providers, etc.
Show child attributes
exchanges
object[]
exchanges such as coinbase, binance, etc
Show child attributes
networks
object[]
Show child attributes
ProjectSettingsChains
⌘I
{
  "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": {
    "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,
      "supportedSecurityMethods": {},
      "chainConfigurations": [
        {
          "name": "<string>",
          "enabled": true,
          "primary": true
        }
      ],
      "domainEnabledByProvider": true,
      "defaultWalletVersion": "V1",
      "promptForKeyExport": true,
      "transactionSimulation": true,
      "svmGasSponsorshipEnabled": 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"
    ]
  },
  "security": {
    "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
        }
      ]
    },
    "externalAuth": {
      "enabled": true,
      "iss": "An example name",
      "aud": "An example name",
      "jwksUrl": "https://website-sample.com",
      "cookieName": "An example name"
    },
    "environmentLocked": true,
    "notifications": {
      "waasPrivateKeyExport": true,
      "waasSignedTransaction": true
    }
  },
  "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>",
      "scopes": "<string>",
      "baseAuthUrl": "<string>",
      "appleKeyId": "<string>",
      "appleTeamId": "<string>",
      "shopifyStore": "<string>",
      "domain": "<string>",
      "accountSid": "<string>",
      "twilioNumber": "<string>",
      "twilioVerifyServiceSid": "<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"
        }
      ]
    }
  ]
}
Overview

Endpoints

Schemas

ProjectSettings

Overview

Endpoints

Schemas

Documentation Index
