Schemas
ProjectSettingsSdk
- Announcements
- System Status
- 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
Rest API
Schemas
ProjectSettingsSdk
emailSignIn
object
emailSignIn.signInProvider
enum<string>
Available options:
dynamic, magicLink, blocto, turnkey, coinbaseWaas socialSignIn
object
socialSignIn.signInProvider
enum<string>
Available options:
dynamic, magicLink, blocto, turnkey, coinbaseWaas socialSignIn.providers
object[]
socialSignIn.providers.provider
enum<string>
requiredAvailable options:
apple, bitbucket, coinbasesocial, discord, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, telegram socialSignIn.providers.enabled
boolean
multiWallet
boolean
multiWalletUnlinkDisabled
boolean
mobile
object
mobile.deeplinkUrlsEnabled
boolean
Whether to enable whitelisting mobile deeplink URLs, which will be used for redirecting back to the mobile app. Is required for many features such as social sign in.
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
embeddedWallets.automaticEmbeddedWalletCreation
boolean
When true embedded wallets will be generated during onboarding for the users. When false customer needs to trigger the creation.
embeddedWallets.showEmbeddedWalletActionsUI
boolean
When true users will see embedded wallets action confirmation views.
embeddedWallets.emailRecoveryEnabled
boolean
When true users will be able to start recovery for their accounts.
embeddedWallets.forceAuthenticatorAtSignup
boolean
When true user will be prompted to add a security method during onboarding. When false user will need to add a security method before a transaction
embeddedWallets.allowSkippingAuthenticatorAtSignup
boolean
When combined with forceAuthenticatorAtSignup it allows user to skip adding a security method during onboarding. User will need to add it before a transaction.
embeddedWallets.sessionKeyDuration
object
embeddedWallets.sessionKeyDuration.amount
integer
requiredembeddedWallets.sessionKeyDuration.unit
enum<string>
requiredAvailable options:
days, hours, minutes embeddedWallets.supportedSecurityMethods
object
embeddedWallets.supportedSecurityMethods.passkey
object
embeddedWallets.supportedSecurityMethods.passkey.isDefault
boolean
requiredembeddedWallets.supportedSecurityMethods.passkey.isEnabled
boolean
requiredembeddedWallets.supportedSecurityMethods.passkey.isPermanentAuthenticator
boolean
requiredembeddedWallets.supportedSecurityMethods.passkey.listPosition
number
requiredembeddedWallets.supportedSecurityMethods.email
object
embeddedWallets.supportedSecurityMethods.email.isDefault
boolean
requiredembeddedWallets.supportedSecurityMethods.email.isEnabled
boolean
requiredembeddedWallets.supportedSecurityMethods.email.isPermanentAuthenticator
boolean
requiredembeddedWallets.supportedSecurityMethods.email.listPosition
number
requiredembeddedWallets.supportedSecurityMethods.password
object
embeddedWallets.supportedSecurityMethods.password.isDefault
boolean
requiredembeddedWallets.supportedSecurityMethods.password.isEnabled
boolean
requiredembeddedWallets.supportedSecurityMethods.password.isPermanentAuthenticator
boolean
requiredembeddedWallets.supportedSecurityMethods.password.listPosition
number
requiredembeddedWallets.chainConfigurations
object[]
Chain specific configuration for dynamic embedded wallets
embeddedWallets.chainConfigurations.name
string
requiredembeddedWallets.chainConfigurations.enabled
boolean
requiredembeddedWallets.chainConfigurations.primary
boolean
requiredembeddedWallets.domainEnabledByProvider
boolean
When a client domain needs to be whitelisted explicitly by one of our embedded wallet providers, this will be true when Dynamic has confirmed that this is the case.
walletConnect
object
walletConnect.projectId
string
walletConnect.v2Enabled
boolean
confirmEmailProviderForVerify
boolean
displayDynamicMessaging
boolean
hideNetworkInDynamicWidget
boolean
preventOrphanedAccounts
boolean
views
object[]
Configs used to create the views in the sdk.
views.type
enum<string>
requiredAvailable options:
login views.sections
object[]
The sections which will be used create the view in the sdk. The sections will be displayed in the order that they appear in the array.
views.sections.type
enum<string>
requiredAvailable options:
email, emailAndPhone, phone, separator, social, text, wallet views.sections.label
string
The label for the section. This will be displayed above the section or as part of the separator component if it is a Separator section.
views.sections.numOfItemsToDisplay
integer
The deafult number of items to display in the section. For Wallet section, represents the number of wallet items to be displayed by default. User has to click a button to view more options if there are any. For Social section, represents the number of social providers to be displayed by default. User has to click a button to view more options if there are any.
views.sections.defaultItem
string
The option to be displayed as the main one. The default item will be displayed in a more prominent way than the rest of the items in the section. For Wallet section, represents the wallet item to be displayed by default. For Social section, represents the social provider to be displayed by default.
views.sections.alignment
enum<string>
Available options:
center, left, right accountAbstraction
object
accountAbstraction.allWallets
boolean
If set to false, will create smart wallets for embedded wallets only.
accountAbstraction.allUsers
boolean
If set to false, will create smart wallets for new users only.
enableMultiAsset
boolean
showFiat
boolean
Was this page helpful?