Environments
Get Live and Sandbox environments by projectId
Rest API
NameServices
- GETGet the name service for the environment and chain
- POSTCreate a new name service for the environment and chain
- DELdelete the name service for the environment and chain
- POSTGet the unsigned chain-specific message needed to be signed by the wallet owner using the wallet private key
- PUTEnable name service for this environment and chain
- PUTDisabled name service for this environment and chain
TestAccount
CustomHostnames
Exports
Gates
Settings
Organizations
Projects
Chainalysis
Environments
Sessions
Wallets
- POSTCreates a new embedded wallet for a user given an identifier
- POSTCreates a new embedded wallet. This API is meant to be called from a frame server.
- GETGet wallets by user
- POSTCreates a new wallet for the user. Note that if the user already has an embedded wallet linked, this call will fail.
- GETGet a wallet using the ID
- DELDelete wallet
Users
Members
MfaSettings
Invites
Origins
Tokens
Allowlists
- GETGet all allowlists for a environment
- POSTCreate new allowlist for a environment
- GETGet allowlist by id
- PUTUpdate the outcome, scope, or name of an allowlist entry by ID
- DELDelete an allowlist
- PUTEnable the allowlist
- PUTDisable the allow list
- GETGet all entries for an allowlist
- POSTCreate a new entry for an allowlist
- DELDelete an allowlist entry
SDK Views
Webhooks
- GETGet the Webhooks for an environment
- POSTCreates a new Webhooks for the project environment
- GETGet the Webhook for an environment
- PUTUpdate the Webhook for an environment
- DELDelete the Webhook for an environment
- GETGet the Messages for an webhook
- GETGet the Message deliveries for a webhook
- POSTRedeliver message for an webhook
SDK
- GETGet exchangerates
- GETCheck user field uniqueness
- POSTInitialize oauth auth sequence
- GETCheck that session is valid
- POSTScan a URL for potential malicious activity
- POSTSimulate a Solana transaction
- POSTSimulate an EVM transaction
- POSTSimulate an EVM AA UserOp
- POSTEndpoint to sign-in using a token issued by an external auth provider
- POSTAdd fees to a Solana transaction
- POSTEndpoint to verify using a token issued by an external auth provider
- GETGet auth token for given embedded wallet type
- GETReturn the passcode for the pregenerated embedded wallet of the authenticated user
- PUTUpdate wallet in a multi-wallet selection
- PUTClaim a pregenerated embedded wallet
- GETReturn the backup key for the embedded wallet of the authenticated user
- POSTUpdate V1 embedded wallet to V2
- GETGet sdk healthcheck
- POSTEndpoint to refresh the JWT auth token using the current valid JWT auth token in the authorization header
- GETGet signin email provider
- GETGet redirect URL for Oauth provider login. This will return a string that the SDK can manipulate before redirecting the browser to.
- GETGet redirect URL for Oauth provider login
- GETOauth provider redirect endpoint
- POSTOauth provider redirect endpoint for apple ID
- GETOauth provider authorization endpoint
- POSTOauth provider verify endpoint
- POSTFarcaster provider SignIn endpoint
- POSTFarcaster provider Verify endpoint
- POSTOauth provider SignIn endpoint
- POSTReturns the authorization code or error retuned by oauth provider
- GETCreate nonce for authentication flow
- POSTPublish events for SDK
- GETGet the environment's settings
- POSTUpdate SDK settings for a specific environment
- POSTLink wallet to user
- POSTMerge users with conflict resolutions
- POSTVerify wallet transfer
- POSTRevoke a session
- POSTunlink wallet from user
- POSTprefetch information for wallet address
- POSTCreate a visit
- POSTVerify payload and return JWT
- GETFetch user profile for the current authenticated user
- PUTUpdate a user's fields
- PUTUpdate a user's Turnkey recovery email
- GETGets passkey data associated with a user
- PUTUpdate a passkey's info
- GETGet the current user's MFA Devices
- GETGet the current user's MFA by device id
- PUTUpdate a device
- DELDelete a device (if not default device)
- GETRegister a new TOTP MFA device and get Totp Secret
- POSTVerify TOTP MFA device
- POSTUpgrade JWT scope with valid MFA session
- GETRegister a new Passkey MFA device
- POSTVerify Passkey MFA device
- GETAuth Passkey MFA device
- POSTUpgrade JWT scope with valid MFA session
- POSTUpgrade JWT scope with valid MFA session
- GETGet recovery codes
- POSTGenerate new recovery codes for user
- POSTAfter successful verification allow to merge two owned accounts
- POSTCreate one or more new embedded wallets for a user
- DELDeletes the embedded wallets for a user
- GETGenerates the turnkey request body for a user's delete wallets request
- POSTAdd a wallet account to a user's existing Turnkey HD wallet
- GETGenerates the turnkey request body for a user's create wallet account request
- POSTInitialize the email authentication process for a user's embedded wallet
- PUTCompletes the passkey recovery process for a user's passkey embedded wallet
- POSTInitialize the passkey recovery process for a user's passkey embedded wallet
- POSTRegisters a session key for an embedded wallet
- GETRequests an export of an embedded wallet
- GETFind the configuration for the enabled networks associated to an environment
- GETConfiguration for enabled onramps
- POSTInitialize email verification process
- POSTInitialize sms verification process
- POSTSend new code for sms verification
- POSTVerify sms verification request
- POSTVerify an sms and sign in user
- POSTVerify email verification request
- POSTVerify an email and sign in user
- POSTSend new code for email verification
- GETFind jwks for public key
- GETGet the token balances for an account
- GETGet HTML with rendered Telegram login widget
- POSTHandle Telegram authentication
- POSTTelegram provider SignIn endpoint
- POSTTelegram provider check auth
- POSTTelegram provider Verify endpoint
Custom Fields
DeeplinkUrls
Environments
Get Live and Sandbox environments by projectId
GET
/
projects
/
{projectId}
/
environments
curl --request GET \
--url https://app.dynamicauth.com/api/v0/projects/{projectId}/environments \
--header 'Authorization: Bearer <token>'{
"environments": {
"live": {
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"settings": {
"chains": [
{
"name": "<string>",
"enabled": true,
"networks": [
{
"networkId": "1",
"chainName": "Ethereum Mainnet",
"enabled": true,
"rpcUrl": "<string>"
}
]
}
],
"kyc": [
{
"name": "<string>",
"required": true,
"enabled": true,
"unique": true,
"verify": true
}
],
"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": "<string>",
"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
},
"providers": [
{
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"provider": "emailOnly",
"enabledAt": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"clientSecret": "<string>",
"providerProjectId": "<string>",
"authorizationUrl": "<string>",
"redirectUrl": "<string>",
"defaultChainId": 123,
"keyExportUrl": "<string>",
"termsAcceptedByUser": {
"termsUrl": "<string>",
"email": "jsmith@example.com",
"userId": "95b11417-f18f-457f-8804-68e361f9164f",
"createdAt": "2023-11-07T05:31:56Z"
},
"appleKeyId": "<string>",
"appleTeamId": "<string>"
}
],
"sdk": {
"socialSignIn": {
"signInProvider": "dynamic",
"providers": [
{
"provider": "apple",
"enabled": true
}
]
},
"multiWallet": true,
"multiWalletUnlinkDisabled": true,
"confirmWalletTransfers": true,
"onrampFunding": true,
"passkeyEmbeddedWalletEnabled": true,
"automaticEmbeddedWalletCreation": true,
"passkeyEmbeddedWalletRecoveryEnabled": true,
"embeddedWalletSecurityMethods": [
"passkey"
],
"walletConnect": {
"projectId": "<string>",
"v2Enabled": true
},
"confirmEmailProviderForVerify": true,
"displayDynamicMessaging": true,
"hideNetworkInDynamicWidget": true,
"preventOrphanedAccounts": true,
"views": [
{
"type": "login",
"sections": [
{
"type": "email",
"label": "<string>",
"numOfItemsToDisplay": 123,
"defaultItem": "<string>"
}
]
}
]
},
"security": {
"jwtDuration": {
"amount": 123,
"unit": "days"
},
"hCaptcha": {
"enabled": true,
"secretKey": "<string>",
"siteKey": "<string>"
}
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"sdkVersion": "<string>"
},
"sandbox": {
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"settings": {
"chains": [
{
"name": "<string>",
"enabled": true,
"networks": [
{
"networkId": "1",
"chainName": "Ethereum Mainnet",
"enabled": true,
"rpcUrl": "<string>"
}
]
}
],
"kyc": [
{
"name": "<string>",
"required": true,
"enabled": true,
"unique": true,
"verify": true
}
],
"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": "<string>",
"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
},
"providers": [
{
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"provider": "emailOnly",
"enabledAt": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"clientSecret": "<string>",
"providerProjectId": "<string>",
"authorizationUrl": "<string>",
"redirectUrl": "<string>",
"defaultChainId": 123,
"keyExportUrl": "<string>",
"termsAcceptedByUser": {
"termsUrl": "<string>",
"email": "jsmith@example.com",
"userId": "95b11417-f18f-457f-8804-68e361f9164f",
"createdAt": "2023-11-07T05:31:56Z"
},
"appleKeyId": "<string>",
"appleTeamId": "<string>"
}
],
"sdk": {
"socialSignIn": {
"signInProvider": "dynamic",
"providers": [
{
"provider": "apple",
"enabled": true
}
]
},
"multiWallet": true,
"multiWalletUnlinkDisabled": true,
"confirmWalletTransfers": true,
"onrampFunding": true,
"passkeyEmbeddedWalletEnabled": true,
"automaticEmbeddedWalletCreation": true,
"passkeyEmbeddedWalletRecoveryEnabled": true,
"embeddedWalletSecurityMethods": [
"passkey"
],
"walletConnect": {
"projectId": "<string>",
"v2Enabled": true
},
"confirmEmailProviderForVerify": true,
"displayDynamicMessaging": true,
"hideNetworkInDynamicWidget": true,
"preventOrphanedAccounts": true,
"views": [
{
"type": "login",
"sections": [
{
"type": "email",
"label": "<string>",
"numOfItemsToDisplay": 123,
"defaultItem": "<string>"
}
]
}
]
},
"security": {
"jwtDuration": {
"amount": 123,
"unit": "days"
},
"hCaptcha": {
"enabled": true,
"secretKey": "<string>",
"siteKey": "<string>"
}
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"sdkVersion": "<string>"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of project
Required string length:
36Response
200
application/json
Project environments response
Required string length:
36Maximum length:
100passkeyEmbeddedWalletEnabled 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
Available options:
passkey, passphrase Configs used to create the views in the sdk.
External integrations like e-mail, social credentials, mpc providers, etc.
Available options:
emailOnly, magicLink, apple, bitbucket, discord, facebook, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, blocto, banxa, dynamic, alchemy, zerodev, turnkey Required string length:
36Standard 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
The default chain id the SDK should use
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.
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.
Required string length:
36Maximum length:
100passkeyEmbeddedWalletEnabled 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
Available options:
passkey, passphrase Configs used to create the views in the sdk.
External integrations like e-mail, social credentials, mpc providers, etc.
Available options:
emailOnly, magicLink, apple, bitbucket, discord, facebook, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, blocto, banxa, dynamic, alchemy, zerodev, turnkey Required string length:
36Standard 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
The default chain id the SDK should use
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.
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.
Was this page helpful?
curl --request GET \
--url https://app.dynamicauth.com/api/v0/projects/{projectId}/environments \
--header 'Authorization: Bearer <token>'{
"environments": {
"live": {
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"settings": {
"chains": [
{
"name": "<string>",
"enabled": true,
"networks": [
{
"networkId": "1",
"chainName": "Ethereum Mainnet",
"enabled": true,
"rpcUrl": "<string>"
}
]
}
],
"kyc": [
{
"name": "<string>",
"required": true,
"enabled": true,
"unique": true,
"verify": true
}
],
"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": "<string>",
"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
},
"providers": [
{
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"provider": "emailOnly",
"enabledAt": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"clientSecret": "<string>",
"providerProjectId": "<string>",
"authorizationUrl": "<string>",
"redirectUrl": "<string>",
"defaultChainId": 123,
"keyExportUrl": "<string>",
"termsAcceptedByUser": {
"termsUrl": "<string>",
"email": "jsmith@example.com",
"userId": "95b11417-f18f-457f-8804-68e361f9164f",
"createdAt": "2023-11-07T05:31:56Z"
},
"appleKeyId": "<string>",
"appleTeamId": "<string>"
}
],
"sdk": {
"socialSignIn": {
"signInProvider": "dynamic",
"providers": [
{
"provider": "apple",
"enabled": true
}
]
},
"multiWallet": true,
"multiWalletUnlinkDisabled": true,
"confirmWalletTransfers": true,
"onrampFunding": true,
"passkeyEmbeddedWalletEnabled": true,
"automaticEmbeddedWalletCreation": true,
"passkeyEmbeddedWalletRecoveryEnabled": true,
"embeddedWalletSecurityMethods": [
"passkey"
],
"walletConnect": {
"projectId": "<string>",
"v2Enabled": true
},
"confirmEmailProviderForVerify": true,
"displayDynamicMessaging": true,
"hideNetworkInDynamicWidget": true,
"preventOrphanedAccounts": true,
"views": [
{
"type": "login",
"sections": [
{
"type": "email",
"label": "<string>",
"numOfItemsToDisplay": 123,
"defaultItem": "<string>"
}
]
}
]
},
"security": {
"jwtDuration": {
"amount": 123,
"unit": "days"
},
"hCaptcha": {
"enabled": true,
"secretKey": "<string>",
"siteKey": "<string>"
}
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"sdkVersion": "<string>"
},
"sandbox": {
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"settings": {
"chains": [
{
"name": "<string>",
"enabled": true,
"networks": [
{
"networkId": "1",
"chainName": "Ethereum Mainnet",
"enabled": true,
"rpcUrl": "<string>"
}
]
}
],
"kyc": [
{
"name": "<string>",
"required": true,
"enabled": true,
"unique": true,
"verify": true
}
],
"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": "<string>",
"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
},
"providers": [
{
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"provider": "emailOnly",
"enabledAt": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"clientSecret": "<string>",
"providerProjectId": "<string>",
"authorizationUrl": "<string>",
"redirectUrl": "<string>",
"defaultChainId": 123,
"keyExportUrl": "<string>",
"termsAcceptedByUser": {
"termsUrl": "<string>",
"email": "jsmith@example.com",
"userId": "95b11417-f18f-457f-8804-68e361f9164f",
"createdAt": "2023-11-07T05:31:56Z"
},
"appleKeyId": "<string>",
"appleTeamId": "<string>"
}
],
"sdk": {
"socialSignIn": {
"signInProvider": "dynamic",
"providers": [
{
"provider": "apple",
"enabled": true
}
]
},
"multiWallet": true,
"multiWalletUnlinkDisabled": true,
"confirmWalletTransfers": true,
"onrampFunding": true,
"passkeyEmbeddedWalletEnabled": true,
"automaticEmbeddedWalletCreation": true,
"passkeyEmbeddedWalletRecoveryEnabled": true,
"embeddedWalletSecurityMethods": [
"passkey"
],
"walletConnect": {
"projectId": "<string>",
"v2Enabled": true
},
"confirmEmailProviderForVerify": true,
"displayDynamicMessaging": true,
"hideNetworkInDynamicWidget": true,
"preventOrphanedAccounts": true,
"views": [
{
"type": "login",
"sections": [
{
"type": "email",
"label": "<string>",
"numOfItemsToDisplay": 123,
"defaultItem": "<string>"
}
]
}
]
},
"security": {
"jwtDuration": {
"amount": 123,
"unit": "days"
},
"hCaptcha": {
"enabled": true,
"secretKey": "<string>",
"siteKey": "<string>"
}
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"sdkVersion": "<string>"
}
}
}