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
Token
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
A 6-character alpha-numeric string checksum of the random API Token. The last 6 characters of the raw token
Example:
"4n3LFC"
Required string length:
36Example:
"95b11417-f18f-457f-8804-68e361f9164f"
Was this page helpful?
{
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"checksum": "4n3LFC",
"createdBy": {
"id": "95b11417-f18f-457f-8804-68e361f9164f",
"alias": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com"
},
"createdAt": "2023-11-07T05:31:56Z",
"note": "<string>",
"projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
"projectEnvironment": {
"id": "95b11417-f18f-457f-8804-68e361f9164f"
}
}