Get an environment by ID

Returns a single environment by its unique identifier.

GET /environments/{environmentId}

Get an environment by ID

cURL

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

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dynamicauth.com/api/v0/environments/{environmentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dynamicauth.com/api/v0/environments/{environmentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.dynamicauth.com/api/v0/environments/{environmentId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "settings": {
    "chains": [
      {
        "name": "<string>",
        "enabled": true,
        "networks": [
          {
            "networkId": "1",
            "chainName": "Ethereum Mainnet",
            "enabled": true,
            "rpcUrl": "<string>",
            "iconUrl": "<string>"
          }
        ]
      }
    ],
    "kyc": [
      {
        "name": "<string>",
        "required": true,
        "enabled": true,
        "unique": true,
        "verify": true,
        "validationRules": {
          "unique": true,
          "regex": "^0x",
          "validOptions": [
            {
              "label": "small"
            },
            {
              "label": "medium"
            },
            {
              "label": "large"
            }
          ],
          "checkboxText": "Agree to the terms and conditions"
        },
        "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": "[e-mail]",
      "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": {},
      "socialSignIn": {
        "providers": [
          {
            "enabled": true
          }
        ]
      },
      "exchangeOptions": [
        {}
      ],
      "multiWallet": true,
      "multiWalletUnlinkDisabled": true,
      "mobile": {
        "deeplinkUrlsEnabled": true
      },
      "confirmWalletTransfers": true,
      "onrampFunding": true,
      "passkeyEmbeddedWalletEnabled": true,
      "automaticEmbeddedWalletCreation": true,
      "passkeyEmbeddedWalletRecoveryEnabled": true,
      "embeddedWalletSecurityMethods": [],
      "embeddedWallets": {
        "automaticEmbeddedWalletCreation": true,
        "automaticEmbeddedWalletCreationForExternal": true,
        "showEmbeddedWalletActionsUI": true,
        "emailRecoveryEnabled": true,
        "forceAuthenticatorAtSignup": true,
        "allowSkippingAuthenticatorAtSignup": true,
        "sessionKeyDuration": {
          "amount": 123
        },
        "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,
        "promptForKeyExport": true,
        "transactionSimulation": true,
        "evmGasSponsorshipEnabled": true,
        "svmGasSponsorshipEnabled": true
      },
      "waas": {
        "passcodeRequired": true,
        "onSignUp": {
          "promptBackupOptions": true,
          "promptClientShareExport": true
        },
        "backupOptions": [],
        "allowMultipleWaasWalletsPerChain": true,
        "iCloud": {
          "containerIdentifier": "<string>",
          "apiToken": "<string>"
        },
        "relayUrl": "<string>",
        "delegatedAccessEndpoint": "<string>",
        "delegatedAccess": {
          "enabled": true,
          "promptUsersOnSignIn": true,
          "requiresDelegation": true
        },
        "offlineRecovery": {
          "enabled": true
        },
        "enableForwardMPCClient": true,
        "customKeyshareRelayBaseUrl": "<string>",
        "exportDisabled": true,
        "fireblocksMigration": {
          "backendBaseUrl": "<string>"
        }
      },
      "walletConnect": {
        "projectId": "<string>",
        "v2Enabled": true,
        "walletProjectId": "<string>"
      },
      "confirmEmailProviderForVerify": true,
      "displayDynamicMessaging": true,
      "hideNetworkInDynamicWidget": true,
      "preventOrphanedAccounts": true,
      "views": [
        {
          "type": "login",
          "sections": [
            {
              "label": "<string>",
              "numOfItemsToDisplay": 123,
              "defaultItem": "<string>"
            }
          ]
        }
      ],
      "accountAbstraction": {
        "allWallets": true,
        "allUsers": true,
        "separateSmartWalletAndSigner": true,
        "enablePasskeys": true
      },
      "blockEmailSubaddresses": true,
      "enableMultiAsset": true,
      "showFiat": true,
      "disabledWalletConnectors": [
        "metamask"
      ],
      "funding": {
        "onramps": [],
        "externalWallets": {
          "enabled": true,
          "minAmount": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "defaultSettings": {
            "chainSettings": [
              {
                "token": {
                  "value": "<string>"
                }
              }
            ]
          }
        }
      }
    },
    "security": {
      "jwtDuration": {
        "amount": 123
      },
      "hCaptcha": {
        "enabled": true,
        "secretKey": "<string>",
        "siteKey": "<string>"
      },
      "captcha": {
        "enabled": true,
        "siteKey": "<string>"
      },
      "mfa": {
        "enabled": true,
        "required": true,
        "availableMethods": [],
        "methods": [
          {
            "enabled": true,
            "allowBackupCodes": true
          }
        ],
        "actions": [
          {
            "required": true,
            "tokenExpirySeconds": 330
          }
        ]
      },
      "auth": {
        "storage": [],
        "allowMultipleCredentialsForSignIn": true
      },
      "externalAuth": {
        "enabled": true,
        "iss": "An example name",
        "aud": "An example name",
        "jwksUrl": "https://website-sample.com",
        "cookieName": "An example name",
        "assumeEmailVerified": true
      },
      "deviceRegistrationRequired": true,
      "environmentLocked": true,
      "notifications": {
        "verifiedCredentialLinked": true,
        "verifiedCredentialUnlinked": true,
        "waasPrivateKeyExport": true,
        "waasSignedTransaction": true
      }
    },
    "customFields": [
      {
        "name": "<string>",
        "required": true,
        "enabled": true,
        "unique": true,
        "verify": true,
        "validationRules": {
          "unique": true,
          "regex": "^0x",
          "validOptions": [
            {
              "label": "small"
            },
            {
              "label": "medium"
            },
            {
              "label": "large"
            }
          ],
          "checkboxText": "Agree to the terms and conditions"
        },
        "label": "<string>",
        "position": 123
      }
    ],
    "providers": [
      {
        "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": "[e-mail]",
          "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>",
        "twilioVerifyServiceSid": "<string>",
        "enabledCountries": [
          {
            "isoCountryCode": "US",
            "phoneCountryCode": "An example name"
          }
        ],
        "sendgridIpPoolName": "<string>",
        "factoryAddress": "<string>",
        "paymasterAddress": "<string>",
        "passkeyAddress": "<string>",
        "sessionAddress": "<string>",
        "salt": "<string>",
        "multichainAccountAbstractionProviders": [
          {
            "clientId": "<string>",
            "chain": "<string>",
            "default": true
          }
        ],
        "createNewAccounts": true,
        "enableKernelV3Migration": true,
        "enableEIP7702": true,
        "zerodevBundlerRpcUrl": "<string>",
        "zerodevPaymasterRpcUrl": "<string>",
        "zerodevKernelDelegationAddress": "<string>",
        "zerodevProjectVersion": "<string>",
        "returnUrl": "<string>",
        "cancelUrl": "<string>"
      }
    ],
    "exchanges": [
      {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "enabledAt": "2023-11-07T05:31:56Z"
      }
    ],
    "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",
            "hasNativeToken": true,
            "supportsFeeTokenSelection": false
          }
        ]
      }
    ],
    "checkouts": [
      {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "settlementConfig": {
          "settlements": [
            {
              "tokenAddress": "An example name",
              "chainId": "An example name",
              "symbol": "An example name",
              "tokenDecimals": 18,
              "isNative": true
            }
          ]
        },
        "enableOrchestration": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "destinationConfig": {
          "destinations": [
            {
              "type": "address",
              "identifier": "An example name"
            }
          ]
        },
        "depositConfig": {
          "minimum": "<string>",
          "presets": [
            "<string>"
          ]
        }
      }
    ]
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sdkVersion": "<string>"
}

{
  "error": "No jwt provided!"
}

{
  "error": "Access Forbidden"
}

{
  "error": "Internal Server Error"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Response

200

application/json

Environment response

id · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

settings · object

Show child attributes

createdAt · string<date-time>

ISO 8601 timestamp of when the environment was created

updatedAt · string<date-time>

ISO 8601 timestamp of when the environment was last updated

sdkVersion · string

Latest SDK version reported by the client for this environment