Updates the environment settings

PUT

environments

{environmentId}

Authorization

Path

Body

object

chains

array

design

object

button

object

background

string

fontColor

string

paddingHeight

integer

paddingWidth

integer

radius

integer

modal

object

border

string

brand

string

displayOrder

array

emailOnly

boolean

emailSubmitButtonInsideInput

boolean

primaryColor

string

radius

integer

showWalletsButton

boolean

socialAboveEmail

boolean

splitEmailAndSocial

boolean

template

string

theme

string

view

string

widget

object

backgroundColor

string

border

string

radius

integer

textColor

string

theme

string

general

object

appLogo

string

collectUserDataWelcomeHeader

string

collectUserDataWelcomeMessage

string

displayName

string

emailCompanyName

string

imageUserInAccessList

string

imageUserNotInAccessList

string

skipOptionalKYCFieldDuringOnboarding

boolean

supportEmail

string

supportText

string

supportUrls

object

kyc

array

privacy

object

collectIp

boolean

providers

array

sdk

object

automaticEmbeddedWalletCreation

boolean

confirmEmailProviderForVerify

boolean

confirmWalletTransfers

boolean

displayDynamicMessaging

boolean

embeddedWalletSecurityMethods

array

hideNetworkInDynamicWidget

boolean

multiWallet

boolean

multiWalletUnlinkDisabled

boolean

onrampFunding

boolean

passkeyEmbeddedWalletEnabled

boolean

passkeyEmbeddedWalletRecoveryEnabled

boolean

preventOrphanedAccounts

boolean

socialSignIn

object

providers

array

signInProvider

enum<string>

views

array

walletConnect

object

projectId

string

v2Enabled

boolean

security

object

hCaptcha

object

enabled

boolean

secretKey

string

siteKey

string

jwtDuration

object

amount

integer

unit

enum<string>

curl --request PUT \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "chains": [
    {
      "enabled": true,
      "name": "<string>",
      "networks": []
    }
  ],
  "design": {
    "button": {},
    "modal": {},
    "widget": {}
  },
  "general": {
    "appLogo": "<string>",
    "collectUserDataWelcomeHeader": "<string>",
    "collectUserDataWelcomeMessage": "<string>",
    "displayName": "<string>",
    "emailCompanyName": "An example name",
    "imageUserInAccessList": "<string>",
    "imageUserNotInAccessList": "<string>",
    "skipOptionalKYCFieldDuringOnboarding": true,
    "supportEmail": "jsmith@example.com",
    "supportText": "<string>",
    "supportUrls": {
      "slack": "https://dynamic.xyz",
      "twitter": "https://dynamic.xyz"
    }
  },
  "kyc": [
    {
      "enabled": true,
      "name": "<string>",
      "required": true,
      "unique": true,
      "verify": true
    }
  ],
  "privacy": {
    "collectIp": true
  },
  "providers": [
    {
      "appleKeyId": "<string>",
      "appleTeamId": "<string>",
      "authorizationUrl": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "defaultChainId": 123,
      "enabledAt": "2023-11-07T05:31:56Z",
      "id": "95b11417-f18f-457f-8804-68e361f9164f",
      "keyExportUrl": "<string>",
      "provider": "emailOnly",
      "providerProjectId": "<string>",
      "redirectUrl": "<string>",
      "termsAcceptedByUser": {
        "createdAt": "2023-11-07T05:31:56Z",
        "email": "jsmith@example.com",
        "termsUrl": "<string>",
        "userId": "95b11417-f18f-457f-8804-68e361f9164f"
      }
    }
  ],
  "sdk": {
    "automaticEmbeddedWalletCreation": true,
    "confirmEmailProviderForVerify": true,
    "confirmWalletTransfers": true,
    "displayDynamicMessaging": true,
    "embeddedWalletSecurityMethods": [],
    "hideNetworkInDynamicWidget": true,
    "multiWallet": true,
    "multiWalletUnlinkDisabled": true,
    "onrampFunding": true,
    "passkeyEmbeddedWalletEnabled": true,
    "passkeyEmbeddedWalletRecoveryEnabled": true,
    "preventOrphanedAccounts": true,
    "socialSignIn": {},
    "views": [],
    "walletConnect": {}
  },
  "security": {
    "hCaptcha": {},
    "jwtDuration": {
      "amount": 123,
      "unit": "days"
    }
  }
}'

{
  "chains": [
    {
      "enabled": true,
      "name": "<string>",
      "networks": []
    }
  ],
  "design": {
    "button": {},
    "modal": {},
    "widget": {}
  },
  "general": {
    "appLogo": "<string>",
    "collectUserDataWelcomeHeader": "<string>",
    "collectUserDataWelcomeMessage": "<string>",
    "displayName": "<string>",
    "emailCompanyName": "An example name",
    "imageUserInAccessList": "<string>",
    "imageUserNotInAccessList": "<string>",
    "skipOptionalKYCFieldDuringOnboarding": true,
    "supportEmail": "jsmith@example.com",
    "supportText": "<string>",
    "supportUrls": {
      "slack": "https://dynamic.xyz",
      "twitter": "https://dynamic.xyz"
    }
  },
  "kyc": [
    {
      "enabled": true,
      "name": "<string>",
      "required": true,
      "unique": true,
      "verify": true
    }
  ],
  "privacy": {
    "collectIp": true
  },
  "providers": [
    {
      "appleKeyId": "<string>",
      "appleTeamId": "<string>",
      "authorizationUrl": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "defaultChainId": 123,
      "enabledAt": "2023-11-07T05:31:56Z",
      "id": "95b11417-f18f-457f-8804-68e361f9164f",
      "keyExportUrl": "<string>",
      "provider": "emailOnly",
      "providerProjectId": "<string>",
      "redirectUrl": "<string>",
      "termsAcceptedByUser": {
        "createdAt": "2023-11-07T05:31:56Z",
        "email": "jsmith@example.com",
        "termsUrl": "<string>",
        "userId": "95b11417-f18f-457f-8804-68e361f9164f"
      }
    }
  ],
  "sdk": {
    "automaticEmbeddedWalletCreation": true,
    "confirmEmailProviderForVerify": true,
    "confirmWalletTransfers": true,
    "displayDynamicMessaging": true,
    "embeddedWalletSecurityMethods": [],
    "hideNetworkInDynamicWidget": true,
    "multiWallet": true,
    "multiWalletUnlinkDisabled": true,
    "onrampFunding": true,
    "passkeyEmbeddedWalletEnabled": true,
    "passkeyEmbeddedWalletRecoveryEnabled": true,
    "preventOrphanedAccounts": true,
    "socialSignIn": {},
    "views": [],
    "walletConnect": {}
  },
  "security": {
    "hCaptcha": {},
    "jwtDuration": {
      "amount": 123,
      "unit": "days"
    }
  }
}

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId

string

required

ID of the environment

Body

application/json

chains

object[]

required

design

object

required

general

object

required

kyc

object[]

required

privacy

object

required

providers

object[]

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

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

integer

The default chain id the SDK should use

providers.enabledAt

string | null

providers.id

string

providers.keyExportUrl

string

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

providers.provider

enum<string>

required

Available options:

emailOnly,

magicLink,

apple,

bitbucket,

discord,

facebook,

github,

gitlab,

google,

instagram,

linkedin,

microsoft,

twitch,

twitter,

blocto,

banxa,

dynamic,

alchemy,

zerodev,

turnkey

providers.providerProjectId

string

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

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

object

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

sdk

object

required

sdk.automaticEmbeddedWalletCreation

boolean

sdk.confirmEmailProviderForVerify

boolean

sdk.confirmWalletTransfers

boolean

sdk.displayDynamicMessaging

boolean

sdk.embeddedWalletSecurityMethods

enum<string>[]

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

Available options:

passkey,

passphrase

sdk.hideNetworkInDynamicWidget

boolean

sdk.multiWallet

boolean

sdk.multiWalletUnlinkDisabled

boolean

sdk.onrampFunding

boolean

sdk.passkeyEmbeddedWalletEnabled

boolean

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

sdk.passkeyEmbeddedWalletRecoveryEnabled

boolean

sdk.preventOrphanedAccounts

boolean

sdk.socialSignIn

object

sdk.views

object[]

Configs used to create the views in the sdk.

sdk.walletConnect

object

security

object

required

Response

200 - application/json

chains

object[]

required

design

object

required

general

object

required

kyc

object[]

required

privacy

object

required

providers

object[]

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

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

integer

The default chain id the SDK should use

providers.enabledAt

string | null

providers.id

string

providers.keyExportUrl

string

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

providers.provider

enum<string>

required

Available options:

emailOnly,

magicLink,

apple,

bitbucket,

discord,

facebook,

github,

gitlab,

google,

instagram,

linkedin,

microsoft,

twitch,

twitter,

blocto,

banxa,

dynamic,

alchemy,

zerodev,

turnkey

providers.providerProjectId

string

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

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

object

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

sdk

object

required

sdk.automaticEmbeddedWalletCreation

boolean

sdk.confirmEmailProviderForVerify

boolean

sdk.confirmWalletTransfers

boolean

sdk.displayDynamicMessaging

boolean

sdk.embeddedWalletSecurityMethods

enum<string>[]

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

Available options:

passkey,

passphrase

sdk.hideNetworkInDynamicWidget

boolean

sdk.multiWallet

boolean

sdk.multiWalletUnlinkDisabled

boolean

sdk.onrampFunding

boolean

sdk.passkeyEmbeddedWalletEnabled

boolean

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

sdk.passkeyEmbeddedWalletRecoveryEnabled

boolean

sdk.preventOrphanedAccounts

boolean

sdk.socialSignIn

object

sdk.views

object[]

Configs used to create the views in the sdk.

sdk.walletConnect

object

security

object

required

Was this page helpful?

Find an environment by ID Gets the list of event types

curl --request PUT \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "chains": [
    {
      "enabled": true,
      "name": "<string>",
      "networks": []
    }
  ],
  "design": {
    "button": {},
    "modal": {},
    "widget": {}
  },
  "general": {
    "appLogo": "<string>",
    "collectUserDataWelcomeHeader": "<string>",
    "collectUserDataWelcomeMessage": "<string>",
    "displayName": "<string>",
    "emailCompanyName": "An example name",
    "imageUserInAccessList": "<string>",
    "imageUserNotInAccessList": "<string>",
    "skipOptionalKYCFieldDuringOnboarding": true,
    "supportEmail": "jsmith@example.com",
    "supportText": "<string>",
    "supportUrls": {
      "slack": "https://dynamic.xyz",
      "twitter": "https://dynamic.xyz"
    }
  },
  "kyc": [
    {
      "enabled": true,
      "name": "<string>",
      "required": true,
      "unique": true,
      "verify": true
    }
  ],
  "privacy": {
    "collectIp": true
  },
  "providers": [
    {
      "appleKeyId": "<string>",
      "appleTeamId": "<string>",
      "authorizationUrl": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "defaultChainId": 123,
      "enabledAt": "2023-11-07T05:31:56Z",
      "id": "95b11417-f18f-457f-8804-68e361f9164f",
      "keyExportUrl": "<string>",
      "provider": "emailOnly",
      "providerProjectId": "<string>",
      "redirectUrl": "<string>",
      "termsAcceptedByUser": {
        "createdAt": "2023-11-07T05:31:56Z",
        "email": "jsmith@example.com",
        "termsUrl": "<string>",
        "userId": "95b11417-f18f-457f-8804-68e361f9164f"
      }
    }
  ],
  "sdk": {
    "automaticEmbeddedWalletCreation": true,
    "confirmEmailProviderForVerify": true,
    "confirmWalletTransfers": true,
    "displayDynamicMessaging": true,
    "embeddedWalletSecurityMethods": [],
    "hideNetworkInDynamicWidget": true,
    "multiWallet": true,
    "multiWalletUnlinkDisabled": true,
    "onrampFunding": true,
    "passkeyEmbeddedWalletEnabled": true,
    "passkeyEmbeddedWalletRecoveryEnabled": true,
    "preventOrphanedAccounts": true,
    "socialSignIn": {},
    "views": [],
    "walletConnect": {}
  },
  "security": {
    "hCaptcha": {},
    "jwtDuration": {
      "amount": 123,
      "unit": "days"
    }
  }
}'

{
  "chains": [
    {
      "enabled": true,
      "name": "<string>",
      "networks": []
    }
  ],
  "design": {
    "button": {},
    "modal": {},
    "widget": {}
  },
  "general": {
    "appLogo": "<string>",
    "collectUserDataWelcomeHeader": "<string>",
    "collectUserDataWelcomeMessage": "<string>",
    "displayName": "<string>",
    "emailCompanyName": "An example name",
    "imageUserInAccessList": "<string>",
    "imageUserNotInAccessList": "<string>",
    "skipOptionalKYCFieldDuringOnboarding": true,
    "supportEmail": "jsmith@example.com",
    "supportText": "<string>",
    "supportUrls": {
      "slack": "https://dynamic.xyz",
      "twitter": "https://dynamic.xyz"
    }
  },
  "kyc": [
    {
      "enabled": true,
      "name": "<string>",
      "required": true,
      "unique": true,
      "verify": true
    }
  ],
  "privacy": {
    "collectIp": true
  },
  "providers": [
    {
      "appleKeyId": "<string>",
      "appleTeamId": "<string>",
      "authorizationUrl": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "defaultChainId": 123,
      "enabledAt": "2023-11-07T05:31:56Z",
      "id": "95b11417-f18f-457f-8804-68e361f9164f",
      "keyExportUrl": "<string>",
      "provider": "emailOnly",
      "providerProjectId": "<string>",
      "redirectUrl": "<string>",
      "termsAcceptedByUser": {
        "createdAt": "2023-11-07T05:31:56Z",
        "email": "jsmith@example.com",
        "termsUrl": "<string>",
        "userId": "95b11417-f18f-457f-8804-68e361f9164f"
      }
    }
  ],
  "sdk": {
    "automaticEmbeddedWalletCreation": true,
    "confirmEmailProviderForVerify": true,
    "confirmWalletTransfers": true,
    "displayDynamicMessaging": true,
    "embeddedWalletSecurityMethods": [],
    "hideNetworkInDynamicWidget": true,
    "multiWallet": true,
    "multiWalletUnlinkDisabled": true,
    "onrampFunding": true,
    "passkeyEmbeddedWalletEnabled": true,
    "passkeyEmbeddedWalletRecoveryEnabled": true,
    "preventOrphanedAccounts": true,
    "socialSignIn": {},
    "views": [],
    "walletConnect": {}
  },
  "security": {
    "hCaptcha": {},
    "jwtDuration": {
      "amount": 123,
      "unit": "days"
    }
  }
}

Rest API

Authorizations

Path Parameters

Body

Response