Rest API
- Introduction
- allowlists
- analytics
- chainalysis
- chains
- custom fields
- environments
- events
- exports
- externaljwt
- gates
- members
- organizations
- origins
- projects
- invites
- sdk views
- settings
- tokens
- sessions
- users
- wallets
- webhooks
- Schemas
- AccessOutcomeEnum
- AddDeeplinkUrlRequest
- Allowlist
- AllowlistEntriesResponse
- AllowlistEntry
- AnalyticsSessionsByDate
- AnalyticsVisitResponse
- AnalyticsWalletsBreakdownResponse
- AuthModeEnum
- AuthSettings
- AuthStorageEnum
- AuthenticatorTransportProtocol
- BadRequest
- BaseUser
- BillingSubscription
- BillingSubscriptionPeriod
- BillingSubscriptionPlanTypeEnum
- BulkUserCreateResponse
- ChainConfiguration
- ChainConfigurations
- ChainEnum
- ChainToken
- ChainTokensResponse
- ChainalysisCheck
- ChainalysisCheckResultEnum
- ChainalysisConfiguration
- CoinbaseMpcWalletProperties
- CompletePasskeyRecoveryRequest
- ConnectRequest
- CountryCode
- CreateEmbeddedWalletParams
- CreateEmbeddedWalletSpecificOpts
- CreateEmbeddedWalletsRequest
- CreateMfaToken
- CreateProjectResponse
- CreateTokenResponse
- CreateTurnkeyEmbeddedWalletSpecificOpts
- CreateUserEmbeddedWalletsFromFarcasterRequest
- CreateUserEmbeddedWalletsRequest
- CreateUserOauthRequest
- CreateWalletRequest
- Currency
- CurrencyType
- CustomField
- CustomFieldRequest
- CustomFieldType
- CustomFieldValidValue
- CustomFieldValidationRules
- CustomFieldsResponse
- CustomHostname
- CustomHostnameCreateRequest
- CustomHostnameStatusEnum
- CustomHostnameVerificationRecord
- CustomHostnameVerificationType
- CustomHostnamesResponse
- DeeplinkUrlResponse
- DeeplinkUrlsResponse
- DnsRecordType
- Duration
- DynamicJwt
- EmailProviderResponse
- EmailVerificationCreateRequest
- EmailVerificationCreateResponse
- EmailVerificationRetryRequest
- EmailVerificationVerifyRequest
- EmbeddedWalletAuthToken
- EmbeddedWalletAuthType
- EmbeddedWalletPasscodeClaimRequest
- EmbeddedWalletProviderEnum
- EmbeddedWalletSecret
- EmbeddedWalletSecretWithUpdatedJwt
- EmbeddedWalletSecurityMethod
- EncodedJwt
- EnvironmentEnum
- EnvironmentVisitorsResponse
- EnvironmentsResponse
- ErrorMessageWithCode
- Event
- EventType
- EventTypesResponse
- EventsResponse
- ExchangeRatesResponse
- Export
- ExportCreateRequest
- ExportCreateRequestFilter
- ExportEmbeddedWalletResponse
- ExportFormatEnum
- ExportModelEnum
- ExportStatusEnum
- ExportsResponse
- ExternalAuth
- ExternalAuthSigninRequest
- ExternalJwtCheckRequest
- ExternalJwtCheckResponse
- FarcasterSignInRequest
- Forbidden
- ForbiddenErrorPayload
- ForbiddenWithErrorAndPayload
- FrameworkSettings
- Gate
- GateCreateRequest
- GateRule
- GateRuleFilter
- GateRuleType
- GateUpdateRequest
- GatesResponse
- GetUserPasskeysResponse
- HCaptchaSettings
- HTTPSUrlOrSNSArn
- HardwareWalletEnum
- HardwareWalletProperties
- HealthcheckResponse
- HealthcheckStatus
- InitEmailAuthRequest
- InitEmailAuthResponse
- InitPasskeyRecoveryRequest
- InitPasskeyRecoveryResponse
- IntegrationSetting
- InternalServerError
- InternalUserFields
- Invite
- InviteConflictResponse
- InviteSendRequest
- InviteStatusEnum
- InviteUpdateRequest
- InvitesResponse
- JwksKey
- JwksResponse
- JwtBlockchainAccount
- JwtPayloadDeprecatedInfo
- JwtVerifiedCredential
- JwtVerifiedCredentialFormatEnum
- Key
- KeyResponse
- KycFieldType
- MFAAuthRecoveryDevicePostRequest
- MFAAuthTotpDevicePostRequest
- MFADevice
- MFADeviceType
- MFAGetDeviceResponse
- MFAGetRecoveryCodesResponse
- MFAListDevicesResponse
- MFARegenRecoveryCodesResponse
- MFARegisterTotpDeviceGetResponse
- MFARegisterTotpDevicePostRequest
- MFARegisterTotpDevicePostResponse
- MFASettings
- MFAUpdateDeviceRequest
- MemberResponse
- MemberRoleField
- MembershipEnvironmentIds
- MergeConflicts
- MergeUser
- MergeUserConflict
- MergeUserConflictResolution
- MergeUserConflictResolutions
- MethodNotAllowed
- MfaBackupCodeAcknowledgement
- MinifiedDynamicJwt
- MobileSettings
- NameService
- NameServiceData
- NativeCurrency
- Network
- NetworkConfiguration
- NetworkConfigurationResponse
- NextJsSettings
- NextViewEnum
- NonEmptyIsoCountryCode
- NonEmptyString
- NonEmptyStringWith255MaxLength
- NonEmptyUrl
- NonEmptyUrlWith255MaxLength
- NonceResponse
- NotFound
- OAuthCode
- OAuthError
- OauthProviderLoginUrl
- OauthProviderRequest
- OauthRedirectRequest
- OauthRedirectRequestIdToken
- OauthRedirectUri
- OauthRequest
- OauthResultRequest
- OauthResultResponse
- OauthResultStatus
- OnrampConfiguration
- OptionalHexString
- OptionalNonEmptyString
- OptionalNonEmptyStringWith255MaxLength
- OptionalNonEmptyUrl
- OptionalNonEmptyUrlWith255MaxLength
- OptionalNullableNonEmptyStringWith255MaxLength
- Organization
- OrganizationFields
- OrganizationMember
- OrganizationMembersResponse
- OrganizationMfaSettings
- OrganizationMfaSettingsResponse
- OrganizationRequest
- OrganizationResponse
- OrganizationsResponse
- OriginResponse
- OriginsResponse
- PasskeyRegistrationCredential
- PasskeyStorage
- PasswordSourceTypeEnum
- PasswordString
- PostAllowlistEntriesRequest
- PostAllowlistsRequest
- PostTokenFields
- PrefetchRequest
- Project
- ProjectEnvironment
- ProjectRequest
- ProjectSettings
- ProjectSettingsChains
- ProjectSettingsDesign
- ProjectSettingsDesignButton
- ProjectSettingsDesignModal
- ProjectSettingsDesignWidget
- ProjectSettingsGeneral
- ProjectSettingsGeneralApps
- ProjectSettingsKyc
- ProjectSettingsPrivacy
- ProjectSettingsSdk
- ProjectSettingsSecurity
- ProjectsResponse
- Provider
- ProviderAgreement
- ProviderCreateRequest
- ProviderEnum
- ProviderUpdateRequest
- ProviderUrl
- ProviderUrlsResponse
- ProvidersResponse
- PublishEvents
- ReactSettings
- RegisterSessionKeyRequest
- RoleEnum
- SdkSettingsRequest
- SdkUser
- SdkView
- SdkViewSection
- SdkViewSectionAlignment
- SdkViewSectionType
- SdkViewType
- SdkViewUpdateRequest
- SdkViewsResponse
- Session
- SignInProviderEnum
- SmsCountryCode
- SmsVerificationCreateRequest
- SmsVerificationCreateResponse
- SmsVerificationRetryRequest
- SmsVerificationVerifyRequest
- SocialSignInProvider
- SocialSignInProviderEnum
- SubscriptionAdvancedScopeEnum
- SubscriptionFreeScopeEnum
- SupportedOnrampsResponse
- SupportedSecurityMethod
- SupportedSecurityMethods
- TimeUnitEnum
- Token
- TokenAddress
- TokenBalance
- TokenCreatedBy
- TokenWithRaw
- TokensResponse
- TooManyRequests
- TurnkeySignedRequest
- TurnkeyStamp
- TurnkeyWalletProperties
- Unauthorized
- UnprocessableEntity
- UnprocessableEntityErrorCode
- UnprocessableEntityErrorPayload
- UpdateProjectRequest
- UpdateProjectResponse
- UpdateRecoveryEmailRequest
- UpdateSelfResponse
- UpdateUserPasskeyRequest
- User
- UserFields
- UserFilterableFieldsEnum
- UserIdentifierTypeEnum
- UserOauthAccessTokenResponse
- UserPasskey
- UserResponse
- UserSearchFilterParams
- UserWalletSelectionRequest
- UserWalletsResponse
- Username
- UsersResponse
- ValidCustomHostname
- ValidStringQueryParam
- VerifyRequest
- VerifyResponse
- VerifyUnlinkRequest
- Visitor
- VisitorFilterableFieldsEnum
- VisitorSearchFilterParams
- VisitorsResponse
- Wallet
- WalletAdditionalAddress
- WalletAddressType
- WalletProperties
- WalletProviderEnum
- WalletPublicKey
- Webhook
- WebhookCreateRequest
- WebhookMessage
- WebhookMessageRedeliveryResponse
- WebhookMessagesResponse
- WebhookUpdateRequest
- WebhooksResponse
- WhenToImplementEnum
- btcWalletString
- caip2
- captchaToken
- ckbWalletString
- deeplinkUrl
- dogeWalletString
- emailOrEmptyString
- kasWalletString
- kdaWalletString
- ltcWalletString
- oAuthAccount
- orderBy
- origin
- phoneNumberOrEmptyString
- sixDigitsVerificationToken
- uuid
Schemas
ProjectSettingsSdk
emailSignIn
object
socialSignIn
object
multiWallet
boolean
multiWalletUnlinkDisabled
boolean
mobile
object
confirmWalletTransfers
boolean
onrampFunding
boolean
passkeyEmbeddedWalletEnabled
boolean
deprecatedpasskeyEmbeddedWalletEnabled is deprecated as of v0.19. Please enable embedded wallets using the provider API.
automaticEmbeddedWalletCreation
boolean
passkeyEmbeddedWalletRecoveryEnabled
boolean
embeddedWalletSecurityMethods
enum<string>[]
Embedded wallet authenticator security methods required upon creation of the embedded wallet at onboarding
Available options:
passkey
, passphrase
embeddedWallets
object
walletConnect
object
confirmEmailProviderForVerify
boolean
displayDynamicMessaging
boolean
hideNetworkInDynamicWidget
boolean
preventOrphanedAccounts
boolean
views
object[]
Configs used to create the views in the sdk.
accountAbstraction
object
enableMultiAsset
boolean
showFiat
boolean
disabledWalletConnectors
string[]
Ids of wallet connectors to filter out from available options in the sdk
Was this page helpful?