Dynamic home page
Search...
⌘K
API Reference
Introduction
Allowlists
POST
Create a new entry for an allowlist
POST
Create new allowlist for a environment
DEL
Delete an allowlist entry
DEL
Delete an allowlist
PUT
Disable the allow list
PUT
Enable the allowlist
GET
Get all allowlists for a environment
GET
Get all entries for an allowlist
GET
Get allowlist by id
PUT
Update the outcome, scope, or name of an allowlist entry by ID
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
GlobalWalletAccessControl
GET
Get all the global wallet access control domains for a project environment
PUT
Updates a global wallet access control for this project environment
POST
Creates a global wallet access control for this project environment
PUT
Enable global wallet access control for this environment
PUT
Disabled global wallet access control for this environment
POST
Adds a domain to be allowed or blocked for global wallet access for this project environment
DEL
Delete a global wallet access control domain by id
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
DeeplinkUrls
DEL
Delete a mobile deeplink URL by id
GET
Get all the whitelisted mobile deeplink URLs for a project environment
POST
Whitelists a mobile deeplink URL for this project 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
GET
Get analytics overview data
GET
Get analytics topline data
GET
Get analytics engagement data
GET
Get analytics wallets breakdown data
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
Chains
GET
Get tokens for passed chainName.
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
GET
Get the active embedded wallet versions for an environment
GET
Get wallets by user
GET
Get a wallet using the ID
Legacy (V2 Embedded Wallets Only)
Users
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
deprecated
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
Authentication & Authorization
Wallet Management
Transaction & Network
User Management
Security & Compliance
Integration & Configuration
Analytics & Monitoring
Provider Integration
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
Mfa
DEL
Delete all MFA Devices for the user
Waas
POST
Authenticate for WAAS using api key
Schemas
User
Wallet
Session
SocialSignInProvider
Visitor
NameServiceSigningMessageRequest
NameServiceSigningMessage
NameServiceResponse
TestAccountResponse
CustomHostname
NameServiceCreateRequest
ValidCustomHostname
CustomHostnameCreateRequest
CustomHostnamesResponse
CustomHostnameStatusEnum
DnsRecordType
CustomHostnameVerificationType
CustomHostnameVerificationRecord
CustomHostnameUsageEnum
DeeplinkUrlResponse
DeeplinkUrlsResponse
OauthRedirectRequest
OauthProviderLoginUrl
CreateWalletRequest
EmailProviderResponse
OAuthCode
OAuthError
ValidStringQueryParam
ExportCreateRequest
ExportFormatEnum
ExportModelEnum
ExportStatusEnum
ExportsResponse
Export
AccessOutcomeEnum
WhenToImplementEnum
GateCreateRequest
GateUpdateRequest
Gate
GateRule
GateRuleFilter
GateRuleType
GatesResponse
TokenAddress
ChainToken
ChainTokensResponse
PostAllowlistEntriesRequest
AllowlistEntry
PostAllowlistsRequest
Allowlist
EnvironmentVisitorsResponse
KeyResponse
Key
EnvironmentsResponse
UpdateProjectRequest
UpdateProjectResponse
ProjectRequest
Project
ProjectsResponse
CreateProjectResponse
OrganizationRequest
OrganizationResponse
CustomNetworkRequest
CreateTokenResponse
PostTokenFields
TokenCreatedBy
TokenWithRaw
Token
TokensResponse
OriginResponse
OriginsResponse
RoleEnum
ProviderCreateRequest
ProviderUpdateRequest
ProvidersResponse
ProviderUrlsResponse
ProviderUrl
UserResponse
BulkUserCreateResponse
UserFilterableFieldsEnum
VisitorFilterableFieldsEnum
OrganizationMfaSettingsResponse
OrganizationMfaSettings
OrganizationMembersResponse
OrganizationMember
UsersResponse
VisitorsResponse
SubscriptionFreeScopeEnum
SubscriptionAdvancedScopeEnum
UserWalletsResponse
AllowlistEntriesResponse
UserSearchFilterParams
VisitorSearchFilterParams
AnalyticsWalletsBreakdownResponse
AnalyticsVisitResponse
AnalyticsSessionsByDate
AnalyticsOverviewResponse
ActiveUsersTrendResult
SessionsTrendResult
OrganizationsResponse
Organization
BillingSubscriptionCoupon
BillingSubscription
BillingSubscriptionPeriod
BillingSubscriptionPlanTypeEnum
OrganizationFields
InviteSendRequest
InviteUpdateRequest
InviteStatusEnum
InviteConflictResponse
InvitesResponse
Invite
OAuthAccount
InternalUpdatableUserFields
InternalUserFields
InternalBulkUpdateUserFields
UpdatableEmailOrEmptyString
CreateUserOauthRequest
ProjectEnvironment
ChainalysisConfiguration
ChainalysisCheck
ChainalysisCheckResultEnum
EventType
EventTypesResponse
Event
EventsResponse
WebhookCreateRequest
WebhookUpdateRequest
Webhook
WebhooksResponse
WebhookMessagesResponse
WebhookMessageRedeliveryResponse
WebhookMessage
CustomField
CustomFieldRequest
AddDeeplinkUrlRequest
CustomFieldsResponse
MembershipEnvironmentIds
MemberResponse
MemberRoleField
ExternalJwtCheckRequest
ExternalJwtCheckResponse
CustomNetworkResponse
GlobalWalletSettingsCreateRequest
GlobalWalletSettingsUpdateRequest
WaasAuthenticateResponse
GlobalWalletAccessControlUpdateRequest
GlobalWalletAccessControlDomainCreateRequest
GlobalWalletAccessControlDomainResponse
GlobalWalletAccessControlResponse
AnalyticsToplineResponse
AnalyticsEngagementResponse
AnalyticsWalletsResponse
ActiveWeeklyDaysResult
RetentionTrendResult
SessionsHeatmapResult
WalletsBreakdownResult
UserFieldsCheckParams
UserFieldsCheckEnum
UserFieldsCheckResponse
OauthInitAuthRequest
ExternalAuthSigninRequest
SimulateSVMTransactionRequest
V6UserOp
V7UserOp
SimulateUserOpRequest
SimulateEVMTransactionRequest
SimulateTransactionResponse
AssetExposure
BlockaidValidation
PriceData
Asset
AssetTransfer
AssetDiff
ScanWebsiteUrlRequest
ScanWebsiteUrlResponse
SolanaTransactionOptimizationRequest
SolanaTransactionOptimizationResponse
UserWalletSelectionRequest
UserOauthAccessTokenResponse
CreateExchangeTransferRequest
ExchangeTransferResponse
ExchangeKeyEnum
AccountList
Account
AccountBalances
PasswordSourceTypeEnum
EmbeddedWalletSecret
EmbeddedWalletPasscodeClaimRequest
EmbeddedWalletSecretWithUpdatedJwt
EmbeddedWalletAuthToken
EmbeddedWalletAuthType
HealthcheckResponse
HealthcheckStatus
OauthRedirectRequestIdToken
OauthRedirectUri
OauthProviderRequest
SocialSignInProviderEnum
SignInProviderEnum
EthSolBtcSuiFlowCosmosWalletAddress
HexString
NonEmptyString
NonEmptyIsoCountryCode
PasswordString
NonEmptyStringWith50MaxLength
NonEmptyStringWith255MaxLength
NonEmptyStringWith255MaxLengthAndSpecialChars
NonEmptyBase58StringWith100MaxLength
NonEmptyStringWith4096MaxLength
ThresholdSignatureScheme
OptionalBase58StringWith100MaxLength
OptionalNonEmptyString
OptionalNonEmptyStringWith255MaxLength
OptionalNullableNonEmptyStringWith255MaxLength
OptionalNonEmptyStringWith50MaxLength
OptionalNonEmptyStringWith50MaxLengthNoSpecialChars
OptionalHexString
NonEmptyUrl
NonEmptyUrlWith255MaxLength
HTTPSUrlOrSNSArn
OptionalNonEmptyUrl
OptionalNonEmptyIconUrl
OptionalNonEmptyCssUrl
OptionalNonEmptyUrlWithLocalhostAndDeepLink
OptionalNonEmptyUrlWith255MaxLength
OptionalNonEmptyMarkdownText
WalletPublicKey
SolanaPublicKey
WalletConnectorKey
JwtVerifiedCredentialHashes
MinifiedDynamicJwt
DynamicJwt
JwtPayloadDeprecatedInfo
JwtVerifiedCredentialFormatEnum
JwtVerifiedCredential
JwtBlockchainAccount
NameServiceData
JwksResponse
JwksKey
EncodedJwt
VerifyResponse
EmailVerificationCreateResponse
SmsVerificationCreateResponse
NonceResponse
BadRequest
Unauthorized
Forbidden
UnprocessableEntity
TooManyRequests
NotFound
UnprocessableEntityErrorPayload
MergeConflicts
MergeUserConflict
MergeUser
MergeUserConflictResolutions
MergeUserConflictResolution
UnprocessableEntityErrorCode
ForbiddenWithErrorAndPayload
ForbiddenErrorPayload
ErrorMessageWithCode
MethodNotAllowed
InternalServerError
BadGateway
ProjectSettings
Provider
ProviderEntryPointVersionEnum
ProviderKernelVersionEnum
ProviderAgreement
ProviderEnum
HardwareWalletEnum
ProjectSettingsSecurity
MobileSettings
AuthSettings
ExternalAuth
AuthStorageEnum
HCaptchaSettings
Duration
TimeUnitEnum
ProjectSettingsPrivacy
Funding
ExternalWalletFundingDefaultSettings
ExternalWalletFundingTokenRule
ExternalWalletFundingDefaultChain
OnrampProviders
ProjectSettingsGeneral
ProjectSettingsGeneralApps
FeatureFlags
NameServiceSdkSettings
ProjectSettingsSdk
EmbeddedWalletSecurityMethod
ChainConfigurations
ChainConfiguration
SupportedSecurityMethods
SupportedSecurityMethod
SdkSettingsRequest
FrameworkSettings
ReactSettings
NextJsSettings
ProjectSettingsDesign
ProjectSettingsDesignModal
ProjectSettingsDesignButton
ProjectSettingsDesignWidget
ProjectSettingsChains
ProjectSettingsKyc
IntegrationSetting
VerifyUnlinkRequest
PrefetchRequest
ConnectRequest
AuthModeEnum
FarcasterSignInRequest
TelegramUser
TelegramPostRequest
OauthRequest
OauthResultRequest
OauthResultResponse
OauthResultStatus
VerifyRequest
EmailVerificationCreateRequest
SmsVerificationCreateRequest
SmsVerificationRetryRequest
SmsVerificationVerifyRequest
EmailVerificationVerifyRequest
EmailVerificationRetryRequest
CaptchaToken
Caip2
Uuid
SixDigitsVerificationToken
Origin
DeeplinkUrl
OrderBy
EmbeddedWalletChainEnum
ChainEnum
WaasChainEnum
EnvironmentEnum
WalletProviderEnum
EmbeddedWalletProviderEnum
EmbeddedWalletVersionEnum
WaasBackupOptionsEnum
UpdateSelfResponse
NextViewEnum
BaseUser
SdkUser
UserFields
Username
CountryCode
BtcWalletString
LtcWalletString
DogeWalletString
KdaWalletString
KasWalletString
CkbWalletString
EmailOrEmptyString
PhoneNumberOrEmptyString
NameService
Network
NativeCurrency
NetworkConfiguration
NetworkConfigurationResponse
PublishEvents
SupportedOnrampsResponse
SdkViewType
SdkView
SdkViewSection
SdkViewSectionType
SdkViewSectionAlignment
SdkViewUpdateRequest
SdkViewsResponse
WalletProperties
WalletKeyShareInfo
WalletKeyShareInfoWithEncryptedAccountCredential
WaasWalletProperties
SmartWalletProperties
CoinbaseMpcWalletProperties
HardwareWalletProperties
TurnkeyWalletProperties
UserIdentifierTypeEnum
CreateUserEmbeddedWalletsRequest
CreateUserEmbeddedWalletsFromFarcasterRequest
RegisterEmbeddedWalletSessionKeyResponse
ExportEmbeddedWalletResponse
CreateEmbeddedWalletsRequest
CreateEmbeddedWalletParams
CreateEmbeddedWalletSpecificOpts
CreateTurnkeyEmbeddedWalletSpecificOpts
UpgradeEmbeddedWalletToV2Request
PasskeyRegistrationCredential
UserPasskey
PasskeyStorage
TurnkeySignedRequest
TurnkeyStamp
UpdateRecoveryEmailRequest
UpdateUserPasskeyRequest
AuthenticatorTransportProtocol
InitPasskeyRecoveryRequest
InitPasskeyRecoveryResponse
CompletePasskeyRecoveryRequest
InitEmailAuthRequest
InitEmailAuthResponse
RegisterSessionKeyRequest
GetUserPasskeysResponse
MfaBackupCodeAcknowledgement
MFASettings
MFADeviceType
MFADevice
MFAListDevicesResponse
MFAGetDeviceResponse
MFAUpdateDeviceRequest
MFARegisterTotpDeviceGetResponse
MFARegisterTotpDevicePostRequest
MFARegisterTotpDevicePostResponse
MFARegisterPasskeyDeviceGetResponse
MFARegisterPasskeyDevicePostRequest
MFAAuthPasskeyDeviceGetResponse
MFAAuthPasskeyDevicePostRequest
PasskeyRegisterVerifyRequest
PasskeyAuthRequest
AuthenticatorAttestationResponse
AuthenticatorAssertionResponse
AuthenticationExtensionsClientInputs
AuthenticationExtensionsClientOutputs
PublicKeyCredentialRpEntity
PublicKeyCredentialUserEntity
PublicKeyCredentialParameters
PublicKeyCredentialDescriptor
AttestationConveyancePreference
PublicKeyCredentialType
AuthenticatorSelectionCriteria
AuthenticatorAttachment
ResidentKeyRequirement
UserVerificationRequirement
CreateMfaToken
MFAAuthTotpDevicePostRequest
MFAAuthRecoveryDevicePostRequest
MFAGetRecoveryCodesResponse
MFARegenRecoveryCodesResponse
CurrencyType
Currency
ExchangeRatesResponse
WalletAdditionalAddress
WalletAddressType
KycFieldType
CustomFieldType
CustomFieldValidValue
CustomFieldValidationRules
SmsCountryCode
EcdsaValidatorOptions
TokenBalance
TurnkeyDeleteEmbeddedWalletsRequestBody
TurnkeyDeleteEmbeddedWalletsRequestBodyParameters
DeleteEmbeddedWalletsRequest
CreateWalletAccountRequest
TurnkeyCreateWalletAccountsRequestBody
TurnkeyCreateWalletAccountsRequestBodyParameters
TurnkeyWalletAccount
CreateWaasAccountRequest
ImportWaasPrivateKeyRequest
SignMessageWithWaasRequest
SignTransactionWithWaasRequest
ExportWaasWalletPrivateKeyRequest
BackupMultipleClientKeySharesRequest
BackupMultipleClientKeySharesResponse
RecoverMultipleClientKeySharesRequest
RecoverMultipleClientKeySharesResponse
ReshareRequest
OpenRoomResponse
OpenRoomResponseWithServerKeygenIds
OpenRoomResponseForReshare
GlobalWalletSettings
GlobalWalletAccessControlTypeEnum
ZerodevBundlerProvider
RampConfiguration
SupportedOfframpsResponse
Explore Dynamic
Start Free
Live Support
System Status
Dynamic home page
Search...
⌘K
Ask AI
Explore Dynamic
Start Free
Live Support
System Status
Search...
Navigation
Overview
Implementation Guides
SDK/API References
Recipes
Troubleshooting
Overview
Implementation Guides
SDK/API References
Recipes
Troubleshooting
Schemas
SixDigitsVerificationToken
Copy page
Copy page
A 6-digit number
Example:
"123456"
Was this page helpful?
Yes
No
Previous
Origin
Next
Example
Copy
Ask AI
"123456"
Assistant
Responses are generated using AI and may contain mistakes.