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
- 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
Updates the environment settings
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ID of the environment
External integrations like e-mail, social credentials, mpc providers, etc.
Whether to enable whitelisting mobile deeplink URLs, which will be used for redirecting back to the mobile app. Is required for many features such as social sign in.
passkeyEmbeddedWalletEnabled 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
When true embedded wallets will be generated during onboarding for the users. When false customer needs to trigger the creation.
When true users will see embedded wallets action confirmation views.
When true users will be able to start recovery for their accounts.
When true user will be prompted to add a security method during onboarding. When false user will need to add a security method before a transaction
When combined with forceAuthenticatorAtSignup it allows user to skip adding a security method during onboarding. User will need to add it before a transaction.
Chain specific configuration for dynamic embedded wallets
When a client domain needs to be whitelisted explicitly by one of our embedded wallet providers, this will be true when Dynamic has confirmed that this is the case.
When true, the user will be prompted to export their private key after creating a wallet.
Configs used to create the views in the sdk.
If set to false, will create smart wallets for embedded wallets only.
If set to false, will create smart wallets for new users only.
if set to false, only smart wallet will be in user wallets list.
Ids of wallet connectors to filter out from available options in the sdk
Secret key used to validate captcha response. This will never be surfaced in a GET response.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the environment
36Body
standard, custom Optional validation rules for the custom field
If this field must be unique for every user in the environment
The regex pattern that the text field must match
255The text that will be displayed for the checkbox field
255text, checkbox, select 255255255100dynamic, magicLink, blocto, turnkey, coinbaseWaas dynamic, magicLink, blocto, turnkey, coinbaseWaas apple, bitbucket, coinbasesocial, discord, epicgames, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, telegram, spotify, tiktok, line, steam, shopify Whether to enable whitelisting mobile deeplink URLs, which will be used for redirecting back to the mobile app. Is required for many features such as social sign in.
passkeyEmbeddedWalletEnabled 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
passkey, passphrase When true embedded wallets will be generated during onboarding for the users. When false customer needs to trigger the creation.
When true users will see embedded wallets action confirmation views.
When true users will be able to start recovery for their accounts.
When true user will be prompted to add a security method during onboarding. When false user will need to add a security method before a transaction
When combined with forceAuthenticatorAtSignup it allows user to skip adding a security method during onboarding. User will need to add it before a transaction.
When a client domain needs to be whitelisted explicitly by one of our embedded wallet providers, this will be true when Dynamic has confirmed that this is the case.
V1, V2 When true, the user will be prompted to export their private key after creating a wallet.
Configs used to create the views in the sdk.
login The sections which will be used create the view in the sdk. The sections will be displayed in the order that they appear in the array.
email, emailAndPhone, phone, separator, social, text, wallet The label for the section. This will be displayed above the section or as part of the separator component if it is a Separator section.
The deafult number of items to display in the section. For Wallet section, represents the number of wallet items to be displayed by default. User has to click a button to view more options if there are any. For Social section, represents the number of social providers to be displayed by default. User has to click a button to view more options if there are any.
The option to be displayed as the main one. The default item will be displayed in a more prominent way than the rest of the items in the section. For Wallet section, represents the wallet item to be displayed by default. For Social section, represents the social provider to be displayed by default.
center, left, right If set to false, will create smart wallets for embedded wallets only.
If set to false, will create smart wallets for new users only.
if set to false, only smart wallet will be in user wallets list.
Ids of wallet connectors to filter out from available options in the sdk
localstorage, cookie sandbox, live standard, custom Optional validation rules for the custom field
If this field must be unique for every user in the environment
The regex pattern that the text field must match
255The text that will be displayed for the checkbox field
255text, checkbox, select External integrations like e-mail, social credentials, mpc providers, etc.
36emailOnly, magicLink, apple, bitbucket, coinbasesocial, discord, epicgames, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, blocto, banxa, dynamic, alchemy, zerodev, telegram, turnkey, coinbaseWaas, sms, spotify, tiktok, line, steam, shopify Standard 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
DEPRECATED: Use defaultChain. The default chain id the SDK should use
CAIP-2 Chain ID (https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-2.md)
5 - 41The 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.
The url of the terms and conditions or privacy policy needed to be shown to the client when creating a new provider that requires terms and conditions to be signed before starting configuration.
25525536Optional custom space-delimited list of Oauth scopes for the social provider
Base auth url for oauth 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.
Shopify store required for Shopify Oauth2 applications.
Required to initialize Twilio provider.
Required to initialize Twilio provider. Phone number used to send SMS messages.
v6, v7 v2_4, v3_0, v3_1 zerodev_signer_to_ecdsa, zerodev_multi_chain A light client, compared to a full node, tracks only pieces of certain information on a blockchain. Light clients do not track the entire state of a blockchain and also do not contain every transaction/block of a chain.
[Deprecated] use name property instead
Contains the client private RPC urls
Response
standard, custom Optional validation rules for the custom field
If this field must be unique for every user in the environment
The regex pattern that the text field must match
255The text that will be displayed for the checkbox field
255text, checkbox, select 255255255100dynamic, magicLink, blocto, turnkey, coinbaseWaas dynamic, magicLink, blocto, turnkey, coinbaseWaas apple, bitbucket, coinbasesocial, discord, epicgames, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, telegram, spotify, tiktok, line, steam, shopify Whether to enable whitelisting mobile deeplink URLs, which will be used for redirecting back to the mobile app. Is required for many features such as social sign in.
passkeyEmbeddedWalletEnabled 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
passkey, passphrase When true embedded wallets will be generated during onboarding for the users. When false customer needs to trigger the creation.
When true users will see embedded wallets action confirmation views.
When true users will be able to start recovery for their accounts.
When true user will be prompted to add a security method during onboarding. When false user will need to add a security method before a transaction
When combined with forceAuthenticatorAtSignup it allows user to skip adding a security method during onboarding. User will need to add it before a transaction.
When a client domain needs to be whitelisted explicitly by one of our embedded wallet providers, this will be true when Dynamic has confirmed that this is the case.
V1, V2 When true, the user will be prompted to export their private key after creating a wallet.
Configs used to create the views in the sdk.
login The sections which will be used create the view in the sdk. The sections will be displayed in the order that they appear in the array.
email, emailAndPhone, phone, separator, social, text, wallet The label for the section. This will be displayed above the section or as part of the separator component if it is a Separator section.
The deafult number of items to display in the section. For Wallet section, represents the number of wallet items to be displayed by default. User has to click a button to view more options if there are any. For Social section, represents the number of social providers to be displayed by default. User has to click a button to view more options if there are any.
The option to be displayed as the main one. The default item will be displayed in a more prominent way than the rest of the items in the section. For Wallet section, represents the wallet item to be displayed by default. For Social section, represents the social provider to be displayed by default.
center, left, right If set to false, will create smart wallets for embedded wallets only.
If set to false, will create smart wallets for new users only.
if set to false, only smart wallet will be in user wallets list.
Ids of wallet connectors to filter out from available options in the sdk
localstorage, cookie sandbox, live standard, custom Optional validation rules for the custom field
If this field must be unique for every user in the environment
The regex pattern that the text field must match
255The text that will be displayed for the checkbox field
255text, checkbox, select External integrations like e-mail, social credentials, mpc providers, etc.
36emailOnly, magicLink, apple, bitbucket, coinbasesocial, discord, epicgames, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, blocto, banxa, dynamic, alchemy, zerodev, telegram, turnkey, coinbaseWaas, sms, spotify, tiktok, line, steam, shopify Standard 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
DEPRECATED: Use defaultChain. The default chain id the SDK should use
CAIP-2 Chain ID (https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-2.md)
5 - 41The 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.
The url of the terms and conditions or privacy policy needed to be shown to the client when creating a new provider that requires terms and conditions to be signed before starting configuration.
25525536Optional custom space-delimited list of Oauth scopes for the social provider
Base auth url for oauth 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.
Shopify store required for Shopify Oauth2 applications.
Required to initialize Twilio provider.
Required to initialize Twilio provider. Phone number used to send SMS messages.
v6, v7 v2_4, v3_0, v3_1 zerodev_signer_to_ecdsa, zerodev_multi_chain A light client, compared to a full node, tracks only pieces of certain information on a blockchain. Light clients do not track the entire state of a blockchain and also do not contain every transaction/block of a chain.
[Deprecated] use name property instead
Contains the client private RPC urls