Find an environment by ID

GET

environments

{environmentId}

Authorization

Path

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId} \
  --header 'Authorization: <authorization>'

{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "sdkVersion": "<string>",
  "settings": {
    "chains": [],
    "design": {},
    "general": {},
    "kyc": [],
    "privacy": {},
    "providers": [],
    "sdk": {},
    "security": {}
  },
  "updatedAt": "2023-11-07T05:31:56Z"
}

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

Response

200 - application/json

createdAt

string

required

sdkVersion

string

settings

object

settings.chains

object[]

required

settings.design

object

required

settings.general

object

required

settings.kyc

object[]

required

settings.privacy

object

required

settings.providers

object[]

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

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

integer

The default chain id the SDK should use

settings.providers.enabledAt

string | null

settings.providers.id

string

settings.providers.keyExportUrl

string

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

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

settings.providers.providerProjectId

string

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

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

object

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

settings.sdk

object

required

settings.sdk.automaticEmbeddedWalletCreation

boolean

settings.sdk.confirmEmailProviderForVerify

boolean

settings.sdk.confirmWalletTransfers

boolean

settings.sdk.displayDynamicMessaging

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

boolean

settings.sdk.multiWallet

boolean

settings.sdk.multiWalletUnlinkDisabled

boolean

settings.sdk.onrampFunding

boolean

settings.sdk.passkeyEmbeddedWalletEnabled

boolean

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

settings.sdk.passkeyEmbeddedWalletRecoveryEnabled

boolean

settings.sdk.preventOrphanedAccounts

boolean

settings.sdk.socialSignIn

object

settings.sdk.views

object[]

Configs used to create the views in the sdk.

settings.sdk.walletConnect

object

settings.security

object

required

updatedAt

string

Was this page helpful?

Create a new entry for an allowlist Updates the environment settings

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId} \
  --header 'Authorization: <authorization>'

{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "sdkVersion": "<string>",
  "settings": {
    "chains": [],
    "design": {},
    "general": {},
    "kyc": [],
    "privacy": {},
    "providers": [],
    "sdk": {},
    "security": {}
  },
  "updatedAt": "2023-11-07T05:31:56Z"
}

Rest API

Authorizations

Path Parameters

Response