Dynamic home page

Explore Dynamic
Start Free
Start Free

Documentation

Rest API

Introduction

GlobalWallets

GET
Get the global wallet settings for environment
PUT
Updates the global wallet settings for the environment
POST
Creates the global wallet settings for the environment
PUT
Enable global wallet for this environment
PUT
Disabled global wallet for this environment

NameServices

GET
Get the name service for the environment and chain
POST
Create a new name service for the environment and chain
DEL
delete the name service for the environment and chain
POST
Get the unsigned chain-specific message needed to be signed by the wallet owner using the wallet private key
PUT
Enable name service for this environment and chain
PUT
Disabled name service for this environment and chain

TestAccount

GET
Get the test account for this environemnt
POST
Create a new test account for this environment
DEL
Delete the test account for this environment

CustomHostnames

DEL
Delete the custom hostname
GET
Get the custom hostnames for this environemnt
POST
Create a new custom hostname for this environment

Exports

GET
Get the exports for an environment
POST
Create a new export request for the project environment
GET
Download an export by ID
GET
Get an export using the ID

Gates

GET
Get the gates for an environment
POST
Creates a new gate for the project environment
GET
Gets a gate
PUT
Updates a gate
DEL
Delete a gate
PUT
Enable the gate for the environment
PUT
Disable the gate for the environment

Settings

GET
Get the providers for an environment
POST
Creates a new provider for the project environment
GET
Get the URLs for the environment providers
GET
Gets a provider
PUT
Updates a provider
DEL
Delete a provider by providerId
PUT
Enable the provider for the environment
PUT
Disable the provider for the environment

Analytics

GET
Get environments analyticswallets
GET
Get environments analyticsvisits

Organizations

GET
Fetches all the active organizations that the user has access to
POST
Creates organization
GET
Find the subscription of an organization using its ID
PUT
Upgrade organziation to advanced plan
PUT
Add coupon to subscription
GET
Find an organization by ID
PUT
Update an organization by ID

Projects

GET
Find an project by ID
PUT
Update a project
DEL
Deletes a project by ID
GET
Fetches all the active projects the belong to the organization
POST
Creates a new project

Custom Networks

GET
Get all custom networks for an organization
POST
Create a custom network for an organization
GET
Get a specific custom network
PUT
Update a custom network
DEL
Delete a custom network

Chainalysis

GET
Find the Chainalysis configuration for an environment.
PUT
Enable the Sanctions API
PUT
Disables the Sanctions API

Environments

GET
Find an environment by ID
PUT
Updates the environment settings
GET
Get the unique number of visitors for an environment by environment ID
GET
Get keys for an environment given environmentId
GET
Get Live and Sandbox environments by projectId

Sessions

PUT
Revoke a session

Wallets

POST
Creates a new embedded wallet for a user given an identifier
POST
Creates a new embedded wallet. This API is meant to be called from a frame server.
GET
Get wallets by user (deprecated - use /environments/{environmentId}/users/{userId}/wallets instead)
POST
Creates a new wallet for the user (deprecated - use /environments/{environmentId}/users/{userId}/wallets instead)
GET
Get wallets by user
POST
Creates a new wallet for the user. Note that if the user already has an embedded wallet linked, this call will fail.
GET
Get a wallet using the ID (deprecated - use /environments/{environmentId}/wallets/{walletId} instead)
DEL
Delete wallet (deprecated - use /environments/{environmentId}/wallets/{walletId} instead)
GET
Get a wallet using the ID
DEL
Delete wallet

Users

GET
Get a user by Id (deprecated - use /environments/{environmentId}/users/{userId} instead)
PUT
Update a user (deprecated - use /environments/{environmentId}/users/{userId} instead)
DEL
Delete user (deprecated - use /environments/{environmentId}/users/{userId} instead)
GET
Get a user by Id
PUT
Update a user
DEL
Delete user
GET
Get the access token for a user OAuth account
GET
Get all users for an environment
POST
Creates a new user
POST
Revoke sessions by user ID
POST
Revoke sessions by user ID
POST
Creates many new users

Visits

GET
Get all visitors for an environment

Members

PUT
Update a given members role
DEL
Delete user membership from being an admin of an organization
GET
Get all users that are admins for an organization
GET
Get Membership Environment IDs

MfaSettings

GET
Get all mfa settings for an organization
PUT
Enable the given mfa device for the organization
PUT
Disable the given mfa device for the organization

Invites

GET
Get all the user invites
PUT
Update invite for user (accept/reject)
DEL
Delete invite for user
GET
Fetches all the Invites the belong to the organization
POST
Creates an invite to the organization

ExternalJwt

POST
Check if the external provided JWT is valid for the specified environment

Origins

GET
Get all the allowed origins for a project environment
POST
Adds an allowed origin for this project environment
DEL
Delete a origin by id

UserApiTokens

GET
Get all API Tokens for Dashboard User
POST
Create a new API Token for Dashboard User
DEL
Delete a API token by token id

Tokens

GET
Get all the tokens for a project environment (does not include the raw token)
POST
Create a new API Token
DEL
Delete a token by token id

Allowlists

GET
Get all allowlists for a environment
POST
Create new allowlist for a environment
GET
Get allowlist by id
PUT
Update the outcome, scope, or name of an allowlist entry by ID
DEL
Delete an allowlist
PUT
Enable the allowlist
PUT
Disable the allow list
GET
Get all entries for an allowlist
POST
Create a new entry for an allowlist
DEL
Delete an allowlist entry

Chains

GET
Get tokens for passed chainName.

SDK Views

GET
Get the sdk views for an environment
GET
Get a sdk view given a type and environment
PUT
Updates the configs for the sdk view and project environment

Events

GET
Get event types
GET
Get environment events

Webhooks

GET
Get the Webhooks for an environment
POST
Creates a new Webhooks for the project environment
GET
Get the Webhook for an environment
PUT
Update the Webhook for an environment
DEL
Delete the Webhook for an environment
GET
Get the Messages for an webhook
GET
Get the Message deliveries for a webhook
POST
Redeliver message for an webhook

SDK

GET
Get exchangerates
GET
Check user field uniqueness
POST
Initialize oauth auth sequence
GET
Check that session is valid
POST
Scan a URL for potential malicious activity
POST
Simulate a Solana transaction
POST
Simulate an EVM transaction
POST
Simulate an EVM AA UserOp
POST
Endpoint to sign-in using a token issued by an external auth provider
POST
Add fees to a Solana transaction
POST
[DEPRECATED] Please use /externalAuth/signin instead
GET
Get auth token for given embedded wallet type
GET
Return the passcode for the pregenerated embedded wallet of the authenticated user
PUT
Update wallet in a multi-wallet selection
PUT
Claim a pregenerated embedded wallet
GET
Return the backup key for the embedded wallet of the authenticated user
POST
Update V1 embedded wallet to V2
GET
Get sdk healthcheck
POST
Endpoint to refresh the JWT auth token using the current valid JWT auth token in the authorization header
GET
Get signin email provider
GET
Get redirect URL for Oauth provider login. This will return a string that the SDK can manipulate before redirecting the browser to.
GET
Get redirect URL for Oauth provider login
GET
Oauth provider redirect endpoint
GET
Redirect URL for sign-in with coinbase
POST
Oauth provider redirect endpoint for apple ID
GET
Oauth provider authorization endpoint
POST
Oauth provider verify endpoint
POST
Farcaster provider SignIn endpoint
POST
Farcaster provider Verify endpoint
POST
Oauth provider SignIn endpoint
POST
Returns the authorization code or error retuned by oauth provider
GET
Create nonce for authentication flow
POST
Publish events for SDK
GET
Get the environment's settings
POST
Update SDK settings for a specific environment
POST
Link wallet to user
POST
Merge users with conflict resolutions
POST
Verify wallet transfer
POST
Revoke a session
POST
unlink wallet from user
POST
prefetch information for wallet address
POST
Create a visit
POST
Verify payload and return JWT
GET
Fetch user profile for the current authenticated user
PUT
Update a user's fields
DEL
Hard delete a user
PUT
Update a user's Turnkey recovery email
GET
Gets passkey data associated with a user
PUT
Update a passkey's info
GET
Get the current user's MFA Devices
GET
Get the current user's MFA by device id
PUT
Update a device
DEL
Delete a device (if not default device)
GET
Register a new TOTP MFA device and get Totp Secret
POST
Verify TOTP MFA device
POST
Upgrade JWT scope with valid MFA session
GET
Register a new Passkey MFA device
POST
Verify Passkey MFA device
GET
Auth Passkey MFA device
POST
Upgrade JWT scope with valid MFA session
POST
Upgrade JWT scope with valid MFA session
GET
Get recovery codes
POST
Generate new recovery codes for user
POST
After successful verification allow to merge two owned accounts
POST
Create one or more new embedded wallets for a user
DEL
Deletes the embedded wallets for a user
GET
Generates the turnkey request body for a user's delete wallets request
POST
Add a wallet account to a user's existing Turnkey HD wallet
GET
Generates the turnkey request body for a user's create wallet account request
POST
Initialize the email authentication process for a user's embedded wallet
PUT
Completes the passkey recovery process for a user's passkey embedded wallet
POST
Initialize the passkey recovery process for a user's passkey embedded wallet
POST
Registers a session key for an embedded wallet
GET
Requests an export of an embedded wallet
GET
Find the configuration for the enabled networks associated to an environment
GET
Configuration for enabled onramps
POST
Initialize email verification process
POST
Initialize sms verification process
POST
Send new code for sms verification
POST
Verify sms verification request
POST
Verify an sms and sign in user
POST
Verify email verification request
POST
Verify an email and sign in user
POST
Send new code for email verification
GET
Find jwks for public key
GET
Get sdk exchangerates
GET
Get the token balances for an account
GET
Get HTML with rendered Telegram login widget
POST
Handle Telegram authentication
POST
Telegram provider SignIn endpoint
POST
Telegram provider check auth
POST
Telegram provider Verify endpoint
POST
Create a new waas account
POST
Refresh keyshares
POST
Import an existing private key to create a waas account
POST
Export private Key of a waas account
POST
Sign a message with a waas account
POST
Backup multiple keyShares for a waaS wallet
POST
Backup multiple keyShares for a waaS wallet to Google Drive
POST
Recover multiple keyShares
POST
Reshare secret shares and update the threshold
GET
Get the global wallet settings for the environment
GET
Get the access token for a user OAuth account

Custom Fields

GET
Get the custom fields for an environment
POST
Create a new custom field for an environment
GET
Retrieve a specific custom field by its ID
PUT
Update an existing custom field by its ID
DEL
Delete a specific custom field by its ID

DeeplinkUrls

GET
Get all the whitelisted mobile deeplink URLs for a project environment
POST
Whitelists a mobile deeplink URL for this project environment
DEL
Delete a mobile deeplink URL by id

Mfa

DEL
Delete all MFA Devices for the user

Copy

Ask AI

{
  "provider": "apple",
  "enabled": true
}

SocialSignInProvider

The schema is of type object.

Was this page helpful?

twitter linkedin slack

Powered by Mintlify

Assistant

Responses are generated using AI and may contain mistakes.