Rest API
GlobalWallets
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
Custom Networks
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 (deprecated - use /environments/{environmentId}/users/{userId}/wallets instead)
- POSTCreates a new wallet for the user (deprecated - use /environments/{environmentId}/users/{userId}/wallets instead)
- 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 (deprecated - use /environments/{environmentId}/wallets/{walletId} instead)
- DELDelete wallet (deprecated - use /environments/{environmentId}/wallets/{walletId} instead)
- GETGet a wallet using the ID
- DELDelete wallet
Users
- GETGet a user by Id (deprecated - use /environments/{environmentId}/users/{userId} instead)
- PUTUpdate a user (deprecated - use /environments/{environmentId}/users/{userId} instead)
- DELDelete user (deprecated - use /environments/{environmentId}/users/{userId} instead)
- GETGet a user by Id
- PUTUpdate a user
- DELDelete user
- GETGet the access token for a user OAuth account
- GETGet all users for an environment
- POSTCreates a new user
- POSTRevoke sessions by user ID
- POSTRevoke sessions by user ID
- POSTCreates many new users
Members
MfaSettings
Invites
Origins
UserApiTokens
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
- POST[DEPRECATED] Please use /externalAuth/signin instead
- 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
- GETRedirect URL for sign-in with coinbase
- 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
- DELHard delete a user
- 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 sdk exchangerates
- 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
- POSTCreate a new waas account
- POSTRefresh keyshares
- POSTImport an existing private key to create a waas account
- POSTExport private Key of a waas account
- POSTSign a message with a waas account
- POSTBackup multiple keyShares for a waaS wallet
- POSTBackup multiple keyShares for a waaS wallet to Google Drive
- POSTRecover multiple keyShares
- POSTReshare secret shares and update the threshold
- GETGet the global wallet settings for the environment
- GETGet the access token for a user OAuth account
Custom Fields
DeeplinkUrls
UserResponse
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Available options:
blockchain, email, oauth, passkey, phoneNumber, externalUser This indicates if the user can sign in with this credential
Valid blockchain wallet address, must be an alphanumeric string without any special characters
Maximum length:
255Example:
"0xbF394748301603f18d953C90F0b087CBEC0E1834"
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
This is used to publicly identify a verified credential in a human-friendly way. For example, this will be the email address if credential format=email.
Available options:
browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Available options:
V1, V2, V3 Available options:
zerodev_signer_to_ecdsa, zerodev_multi_chain Available options:
v6, v7 Available options:
v2_4, v3_0, v3_1 Available options:
emailOnly, magicLink, apple, bitbucket, coinbasesocial, discord, epicgames, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, blocto, banxa, coinbaseOnramp, dynamic, alchemy, zerodev, telegram, turnkey, coinbaseWaas, sms, spotify, tiktok, line, steam, shopify This field contains the phone number in the country. This could also contain the area code within a country.
Example:
"9171113333"
This field contains the phone international country code. See https://countrycode.org/
Example:
"1"
ISO-3166 two-character country code. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
Example:
"US"
This object contains JSON metadata for a social-based verified credential. It may contain data about the user that does not fit into the other structured fields, and could include arbitrary fields about the user from the oauth provider's API.
This will only be provided in the responses for GET /users/{userId}.Previous user IDs that owned this verified credential and was tranfered to the current user ID.
An additional address associated with a wallet.
An address associated with a wallet.
Available options:
ordinals, payment, cosmos, evm The public key associated with the address.
This timestamp indicates the last time this verified wallet was either connected to the user account or selected to become the primary wallet on the account.
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Maximum length:
255Example:
"An example name"
Standard ISO 3166-1 alpha-2 two-letter country code
Maximum length:
255Example:
"US"
Maximum length:
255Maximum length:
255Example:
"An example name"
Maximum length:
255Example:
"An example name"
Maximum length:
255Example:
"An example name"
Maximum length:
255Maximum length:
255Example:
"An example name"
Maximum length:
255Example:
"An example name"
Maximum length:
255Example:
"An example name"
Available options:
pending, complete Access lists evaluated by Dynamic when considering access for the user.
A whitespace-separate list of permissions associated with the JWT token issued. This conforms to the JWT standard for scope claims: https://datatracker.ietf.org/doc/html/rfc8693#section-4.2
Example:
"superuser marketing operations"
Available options:
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
Maximum length:
255Example:
"^0x"
The dropdown options for the select field
Example:
[
{ "label": "small" },
{ "label": "medium" },
{ "label": "large" }
]
The text that will be displayed for the checkbox field
Maximum length:
255Example:
"Agree to the terms and conditions"
Available options:
text, checkbox, select Available options:
ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC, ECLIPSE Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Example:
"An example name"
Available options:
ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC, ECLIPSE Valid blockchain wallet address, must be an alphanumeric string without any special characters
Maximum length:
255Example:
"0xbF394748301603f18d953C90F0b087CBEC0E1834"
Available options:
browserExtension, custodialService, walletConnect, qrCode, deepLink, embeddedWallet, smartContractWallet Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Available options:
V1, V2, V3 Available options:
zerodev_signer_to_ecdsa, zerodev_multi_chain Available options:
v6, v7 Available options:
v2_4, v3_0, v3_1 Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Available options:
OK, BLOCKED, FAILED Valid blockchain wallet address, must be an alphanumeric string without any special characters
Maximum length:
255Example:
"0xbF394748301603f18d953C90F0b087CBEC0E1834"
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Available options:
emailOnly, magicLink, apple, bitbucket, coinbasesocial, discord, epicgames, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, blocto, banxa, coinbaseOnramp, dynamic, alchemy, zerodev, telegram, turnkey, coinbaseWaas, sms, spotify, tiktok, line, steam, shopify Available options:
totp, passkey Whether or not the user has a verified this MFA Device
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
The date and time the MFA device was created
The date and time the MFA device was verified
Whether or not this is the default MFA device for the user
The optional alias for the MFA device
Was this page helpful?
{
"user": {
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
"verifiedCredentials": [
{
"address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
"chain": "<string>",
"refId": "95b11417-f18f-457f-8804-68e361f9164f",
"signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
"email": "jsmith@example.com",
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"name_service": {
"avatar": "<string>",
"name": "<string>"
},
"public_identifier": "<string>",
"wallet_name": "<string>",
"wallet_provider": "browserExtension",
"wallet_properties": {
"turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
"turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
"turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
"isAuthenticatorAttached": true,
"turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f",
"isSessionKeyCompatible": true,
"version": "V1",
"ecdsaProviderType": "zerodev_signer_to_ecdsa",
"entryPointVersion": "v6",
"kernelVersion": "v2_4"
},
"format": "blockchain",
"oauth_provider": "emailOnly",
"oauth_username": "<string>",
"oauth_display_name": "<string>",
"oauth_account_id": "<string>",
"phoneNumber": "9171113333",
"phoneCountryCode": "1",
"isoCountryCode": "US",
"oauth_account_photos": [
"<string>"
],
"oauth_emails": [
"<string>"
],
"oauth_metadata": {},
"previous_users": [
"95b11417-f18f-457f-8804-68e361f9164f"
],
"embedded_wallet_id": "<string>",
"wallet_additional_addresses": [
{
"address": "<string>",
"publicKey": "<string>",
"type": "ordinals"
}
],
"lastSelectedAt": "2023-11-07T05:31:56Z",
"signInEnabled": true
}
],
"lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
"sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
"alias": "An example name",
"country": "US",
"email": "jsmith@example.com",
"firstName": "An example name",
"jobTitle": "An example name",
"lastName": "An example name",
"phoneNumber": "<string>",
"policiesConsent": true,
"tShirtSize": "An example name",
"team": "An example name",
"username": "An example name",
"firstVisit": "2023-11-07T05:31:56Z",
"lastVisit": "2023-11-07T05:31:56Z",
"newUser": true,
"metadata": {},
"mfaBackupCodeAcknowledgement": "pending",
"btcWallet": "<string>",
"kdaWallet": "<string>",
"ltcWallet": "<string>",
"ckbWallet": "<string>",
"kasWallet": "<string>",
"dogeWallet": "<string>",
"emailNotification": true,
"discordNotification": true,
"newsletterNotification": true,
"lists": [
"<string>"
],
"scope": "superuser marketing operations",
"missingFields": [
{
"name": "<string>",
"required": true,
"enabled": true,
"unique": true,
"verify": true,
"type": "standard",
"validationRules": {
"unique": true,
"regex": "^0x",
"validOptions": [
{
"label": "small"
},
{
"label": "medium"
},
{
"label": "large"
}
],
"checkboxText": "Agree to the terms and conditions"
},
"validationType": "text",
"label": "<string>",
"position": 123
}
],
"walletPublicKey": "<string>",
"wallet": "<string>",
"chain": "ETH",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"sessions": [
{
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"createdAt": "2023-11-07T05:31:56Z",
"ipAddress": "<string>",
"userAgent": "<string>",
"revokedAt": "2023-11-07T05:31:56Z"
}
],
"wallets": [
{
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"name": "An example name",
"chain": "ETH",
"publicKey": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
"provider": "browserExtension",
"properties": {
"turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
"turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
"turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
"isAuthenticatorAttached": true,
"turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f",
"isSessionKeyCompatible": true,
"version": "V1",
"ecdsaProviderType": "zerodev_signer_to_ecdsa",
"entryPointVersion": "v6",
"kernelVersion": "v2_4"
},
"lastSelectedAt": "<string>"
}
],
"chainalysisChecks": [
{
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"createdAt": "2023-11-07T05:31:56Z",
"result": "OK",
"walletPublicKey": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
"response": "<string>"
}
],
"oauthAccounts": [
{
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"provider": "emailOnly",
"accountUsername": "<string>"
}
],
"mfaDevices": [
{
"type": "totp",
"verified": true,
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"createdAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z",
"default": true,
"alias": "<string>"
}
]
}
}