Allowlists
- POSTCreate a new entry for an allowlist
- POSTCreate new allowlist for a environment
- DELDelete an allowlist entry
- DELDelete an allowlist
- PUTDisable the allow list
- PUTEnable the allowlist
- GETGet all allowlists for a environment
- GETGet all entries for an allowlist
- GETGet allowlist by id
- PUTUpdate the outcome, scope, or name of an allowlist entry by ID
GlobalWallets
GlobalWalletAccessControl
- GETGet all the global wallet access control domains for a project environment
- PUTUpdates a global wallet access control for this project environment
- POSTCreates a global wallet access control for this project environment
- PUTEnable global wallet access control for this environment
- PUTDisabled global wallet access control for this environment
- POSTAdds a domain to be allowed or blocked for global wallet access for this project environment
- DELDelete a global wallet access control domain by id
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
DeeplinkUrls
Exports
Gates
Settings
Analytics
Organizations
Projects
Custom Networks
Chainalysis
Environments
Sessions
Wallets
- GETGet the active embedded wallet versions for an environment
- GETGet wallets by user
- GETGet a wallet using the ID
- Legacy (V2 Embedded Wallets Only)
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
- Authentication & Authorization
- Wallet Management
- Transaction & Network
- User Management
- Security & Compliance
- Integration & Configuration
- Analytics & Monitoring
- Provider Integration
Custom Fields
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
Schemas
CustomFieldValidationRules
Optional validation rules for the custom field
Was this page helpful?
Copy
Ask AI
{
"unique": true,
"regex": "^0x",
"validOptions": [
{
"label": "small"
},
{
"label": "medium"
},
{
"label": "large"
}
],
"checkboxText": "Agree to the terms and conditions"
}Assistant
Responses are generated using AI and may contain mistakes.