- Announcements
- System Status
- Introduction
- allowlists
- analytics
- chainalysis
- chains
- custom fields
- environments
- events
- exports
- externaljwt
- gates
- members
- organizations
- origins
- projects
- invites
- sdk views
- settings
- tokens
- sessions
- users
- wallets
- webhooks
- Schemas
Rest API
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.
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.
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
Body
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
The dropdown options for the select field
The text that will be displayed for the checkbox field
text, checkbox, select 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
The dropdown options for the select field
The text that will be displayed for the checkbox field
text, checkbox, select External integrations like e-mail, social credentials, mpc providers, etc.
ID of the environment
emailOnly, magicLink, apple, bitbucket, coinbasesocial, discord, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, blocto, banxa, dynamic, alchemy, zerodev, telegram, turnkey, coinbaseWaas, sms 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)
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.
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.
ID of the environment
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 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 dynamic, magicLink, blocto, turnkey, coinbaseWaas dynamic, magicLink, blocto, turnkey, coinbaseWaas apple, bitbucket, coinbasesocial, discord, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, telegram 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.
days, hours, minutes 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.
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.
days, hours, minutes Secret key used to validate captcha response. This will never be surfaced in a GET response.
totp localstorage, cookie 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
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
The dropdown options for the select field
The text that will be displayed for the checkbox field
text, checkbox, select 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
The dropdown options for the select field
The text that will be displayed for the checkbox field
text, checkbox, select External integrations like e-mail, social credentials, mpc providers, etc.
ID of the environment
emailOnly, magicLink, apple, bitbucket, coinbasesocial, discord, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, blocto, banxa, dynamic, alchemy, zerodev, telegram, turnkey, coinbaseWaas, sms 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)
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.
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.
ID of the environment
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 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 dynamic, magicLink, blocto, turnkey, coinbaseWaas dynamic, magicLink, blocto, turnkey, coinbaseWaas apple, bitbucket, coinbasesocial, discord, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, telegram 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.
days, hours, minutes 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.
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.
days, hours, minutes Secret key used to validate captcha response. This will never be surfaced in a GET response.
totp localstorage, cookie 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
Was this page helpful?