The identity and technical contract details declared by the specification.
SdkSettingsRequest
object
3 properties
UserPasskey
object
8 properties
3 required
SignInProviderEnum
string
The 'turnkey' value is deprecated and will be removed in a future version.
NonEmptyStringWith255MaxLengthAndSpecialChars
string
ProjectSettingsSecurity
object
7 properties
UserFieldsCheckEnum
string
OAuthError
string
Valid oauth error
ProjectSettingsSdkWaasDelegatedAccess
object
3 properties
PasskeyStorage
object
3 properties
2 required
NonEmptyStringWith50MaxLength
string
ExportEmbeddedWalletResponse
object
1 property
1 required
SupportedOnrampsResponse
object
1 property
EmbeddedWalletAuthType
string
WalletAdditionalAddress
object
An additional address associated with a wallet.
3 properties
2 required
PasskeyExtension
object
4 properties
ReshareRequest
object
5 properties
3 required
FrameworkSettings
object
2 properties
MergeUser
object
Contains the current field value for the user.
2 properties
2 required
GlobalWalletSettings
object
11 properties
2 required
MFARegisterTotpDevicePostRequest
object
2 properties
2 required
ExchangeKeyEnum
string
Source exchange identifier
SdkViewSectionAlignment
string
HardwareWalletEnum
string
BackupMultipleClientKeySharesRequest
object
2 properties
2 required
ProjectSettingsDesignModal
object
13 properties
SponsorSVMTransactionResponse
object
Response containing the sponsored Solana transaction
1 property
ExchangeTransferResponse
object
6 properties
3 required
OptionalNonEmptyString
string
InitPasskeyRecoveryResponse
object
1 property
1 required
PasswordSourceTypeEnum
string
CreateRoomsRequest
object
2 properties
1 required
AuthSettings
object
1 property
1 required
WaasWalletProperties
object
5 properties
NameServiceSdkSettings
object
1 property
1 required
SolanaPublicKey
string
Valid Solana wallet address, must be a 44-character string using base58 characters
EmailProviderResponse
object
1 property
1 required
AuthStorageEnum
string
Location in the browser where Dynamic will attempt to store the JWT token.
MFARegisterPasskeyDeviceGetResponse
object
3 properties
3 required
CreateWalletAccountRequest
object
1 property
1 required
EmbeddedWalletPasscodeClaimRequest
object
1 property
1 required
NonEmptyStringWith4096MaxLength
string
A string with a max length of 4096 characters
TransferDestination
object
2 properties
1 required
WaasWalletSettings
object
4 properties
ExternalWalletFundingTokenRule
string
SimulateEVMTransactionRequest
object
6 properties
5 required
Exchange
object
5 properties
1 required
BackupKeySharesToLocationRequest
object
1 property
1 required
EmbeddedWalletSecret
object
3 properties
2 required
UserWalletSelectionRequest
object
1 property
1 required
NonEmptyIsoCountryCode
string
NextJsSettings
object
1 property
EmbeddedWalletVersionEnum
string
ValidStringQueryParam
string
SignMessageUserOperationData
object
The actual user operation data
16 properties
CoinbaseOnrampOrderPaymentMethod
string
The type of payment method to be used to complete an onramp order.
OauthRedirectRequestIdToken
string
OpenRoomResponseForReshare
SignMessageSvmTransaction
object
Solana serialized transactions
3 properties
3 required
SignMessageContext
object
10 properties
UserFieldsCheckParams
object
2 properties
2 required
ExternalAuthSigninRequest
object
2 properties
SimulateSVMTransactionRequest
object
5 properties
4 required
ProjectSettingsPrivacy
object
1 property
MFAGetRecoveryCodesResponse
object
2 properties
2 required
MFADevice
object
7 properties
SupportedSecurityMethod
object
4 properties
4 required
ExternalAuth
object
5 properties
AuthenticatorAttestationResponse
object
5 properties
2 required
SolanaTransactionOptimizationRequest
object
2 properties
2 required
MFARegenRecoveryCodesResponse
object
2 properties
2 required
PasskeyRelyingParty
object
2 properties
2 required
SmsVerificationCreateResponse
object
4 properties
4 required
EmailVerificationCreateRequest
object
2 properties
1 required
Network
object
6 properties
3 required
ProjectSettings
object
12 properties
7 required
OauthRedirectRequest
object
4 properties
OptionalNonEmptyCssUrl
string
Username
stringnull
Alphanumeric with slugs and underscores username
OptionalNonEmptyIconUrl
string
ForbiddenWithErrorAndPayload
object
2 properties
SocialSignInProviderEnum
string
OptionalNonEmptyStringWith50MaxLength
string
JwtVerifiedCredentialFormatEnum
string
MultichainAccountBalanceResponse
object
1 property
1 required
MFAMethodsResponse
object
3 properties
3 required
BackupMultipleClientKeySharesResponse
object
1 property
1 required
CreateTurnkeyEmbeddedWalletSpecificOpts
object
2 properties
2 required
UpdateUserPasskeyRequest
object
2 properties
1 required
GlobalWalletConnectionStatusEnum
string
SimulateUserOpRequest
object
5 properties
4 required
ExchangeTransaction
object
6 properties
PasskeyRegisterVerifyRequest
object
6 properties
5 required
ChainConfigurations
array
Chain specific configuration for dynamic embedded wallets
OptionalNonEmptyMarkdownText
string
MobileSettings
object
1 property
MFARegisterTotpDeviceGetResponse
object
4 properties
4 required
CoinbaseMpcWalletProperties
object
2 properties
SsoProviderCheckRequest
object
1 property
1 required
InitPasskeyRecoveryRequest
object
2 properties
2 required
MFAAuthTotpDevicePostRequest
object
3 properties
1 required
TransferDestinationResponse
object
2 properties
2 required
captchaToken
string
When provided, used to verify that a captcha is valid and get the success/failure result from the captcha provider server-side.
WalletPublicKey
string
Valid blockchain wallet address, must be an alphanumeric string without any special characters
GetUserPasskeysResponse
object
2 properties
2 required
TurnkeyCreateWalletAccountsRequestBody
object
4 properties
4 required
TurnkeySignedRequest
object
3 properties
3 required
CreateMfaToken
object
1 property
1 required
Forbidden
object
1 property
Eip712TypeMember
object
2 properties
2 required
AuthenticatorSelectionCriteria
object
4 properties
PublicKeyCredentialUserEntity
object
3 properties
3 required
ExportWaasWalletPrivateKeyRequest
object
2 properties
1 required
PasskeyExcludeCredential
object
3 properties
2 required
TurnkeyCreateWalletAccountsRequestBodyParameters
object
2 properties
2 required
WaasBackupOptionsEnum
string
CoinbaseOnrampOrderResponse
object
2 properties
1 required
NameServiceData
object
2 properties
SmsCountryCode
object
2 properties
2 required
BadRequest
object
1 property
SmsVerificationRetryRequest
object
5 properties
4 required
CryptoDotComPaymentResponse
object
20 properties
6 required
SmartWalletProperties
object
3 properties
CryptoDotComPaymentCreateRequest
object
10 properties
4 required
NonEmptyUrlWith255MaxLength
string
Currency
object
5 properties
5 required
RecoverMultipleClientKeySharesResponse
object
1 property
1 required
PasskeyCredentialType
string
PriceData
object
1 property
MFAListDevicesResponse
object
2 properties
2 required
PublicKeyCredentialRpEntity
object
2 properties
1 required
CreateEmbeddedWalletsRequest
object
1 property
1 required
PasskeyRegistrationCredentialV2
object
4 properties
2 required
ProviderEnum
string
The 'turnkey' value is deprecated and will be removed in a future version.
JwksKey
object
Contains a valid JWKS representation of the public key for this environment. For more information, see: https://auth0.com/blog/navigating-rs256-and-jwks/
6 properties
caip2
string
CAIP-2 Chain ID (https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-2.md)
AccountBalances
object
4 properties
2 required
HealthcheckResponse
object
1 property
1 required
OauthProviderLoginUrl
object
1 property
1 required
RegisterEmbeddedWalletSessionKeyResponse
object
2 properties
2 required
UpdateRecoveryEmailRequest
object
1 property
1 required
origin
string
An [RFC 6454](https://www.rfc-editor.org/rfc/rfc6454) valid url. Must not include any paths. A single wildcard () can be used as the first subdomain.
OauthResultResponse
object
3 properties
1 required
BlockaidValidation
object
4 properties
2 required
SecurityNotifications
object
2 properties
TooManyRequests
object
1 property
NameService
object
1 property
ckbWalletString
stringnull
CKB wallet address
DeleteEmbeddedWalletsRequest
object
1 property
1 required
CreateWaasAccountRequest
object
5 properties
2 required
dogeWalletString
stringnull
DOGE wallet address
SponsorSVMTransactionRequest
object
Request to sponsor a Solana transaction via Grid API
1 property
1 required
SdkViewSection
object
A section used create the view in the sdk.
5 properties
1 required
UserVerificationRequirement
string
SolanaTransactionOptimizationResponse
object
1 property
1 required
MergeUserConflictResolution
object
Contains the field key and the userId for whose information we need to keep
3 properties
3 required
MfaBackupCodeAcknowledgement
stringnull
DeleteUserPasskeyRequest
object
1 property
1 required
ExternalWalletFundingDefaultSettings
object
2 properties
CoinbaseOnrampFeeType
string
The type of fee.
CoinbaseOnrampOrder
object
16 properties
14 required
AuthenticationExtensionsClientOutputs
object
3 properties
CoinbaseOnrampOrderCreateRequest
object
11 properties
7 required
OpenRoomResponseWithServerKeygenIds
EmailVerificationVerifyRequest
object
4 properties
2 required
AuthenticatorAssertionResponse
object
4 properties
3 required
SignMessageEvmMessage
EVM message that can be either a plain string or an object with raw hex data
EmbeddedWalletSecurityMethod
string
AuthenticatorTransportProtocol
string
PublicKeyCredentialParameters
object
2 properties
2 required
MFARegisterPasskeyDevicePostRequest
object
2 properties
2 required
AssetDiff
object
3 properties
3 required
ZerodevBundlerProvider
string
ProjectSettingsDesign
object
3 properties
AuthenticatorAttachment
string
SignMessageEip7702Auth
object
EIP-7702 auth
3 properties
3 required
WalletTransaction
object
11 properties
11 required
OptionalNonEmptyUrlWithLocalhostAndDeepLink
string
BackupKeySharesToLocationsResponse
object
3 properties
3 required
GetPasskeyAuthenticationOptionsResponse
object
7 properties
1 required
sixDigitsVerificationToken
string
A 6-digit number
NotFound
object
2 properties
2 required
SignMessageEvmTypedData
object
EIP-712 typed data payload
4 properties
4 required
ForbiddenErrorPayload
object
2 properties
OauthProviderRequest
object
3 properties
OauthInitAuthRequest
object
3 properties
1 required
GetPasskeyRegistrationOptionsResponse
object
10 properties
8 required
UserOauthAccessTokenResponse
object
1 property
1 required
CreateRoomsWithoutWalletIdRequest
object
3 properties
2 required
PasskeyUser
object
3 properties
3 required
NonEmptyBase58StringWith100MaxLength
string
A base58 string with a max length of 100 characters
VerifyResponse
object
5 properties
2 required
NonceResponse
object
1 property
SmsVerificationCreateRequest
object
4 properties
3 required
CreateEmbeddedWalletParams
object
7 properties
1 required
PasskeyAllowCredential
object
2 properties
1 required
NonEmptyStringWith255MaxLength
string
OptionalNonEmptyStringWith255MaxLength
string
ProjectSettingsSdk
object
28 properties
OptionalNullableNonEmptyStringWith255MaxLength
stringnull
ExchangeOption
object
3 properties
1 required
ProviderAgreement
object
Reference to the user that accepted the terms and conditions, if one is necessary for this provider.
4 properties
4 required
CoinbaseOnrampBuyUrlExperience
string
Default visual experience. Either transfer funds from Coinbase (send) or buy assets (buy)
WalletTransactionAssetTransfer
object
5 properties
3 required
CountryCode
stringnull
Standard ISO 3166-1 alpha-2 two-letter country code
TurnkeyDeleteEmbeddedWalletsRequestBody
object
4 properties
4 required
CoinbaseOnrampOrderPaymentLinkType
string
The type of payment link.
OpenRoomResponse
object
4 properties
1 required
UpdateWaasWalletSettingsRequest
object
1 property
1 required
ProviderEntryPointVersionEnum
string
SignMessageEvmTransaction
object
Standard EVM transaction
9 properties
2 required
UnprocessableEntity
object
3 properties
1 required
InitEmailAuthResponse
object
2 properties
2 required
btcWalletString
stringnull
BTC wallet address
NonEmptyDomainUrlWith255MaxLength
string
SignMessageWithWaasRequest
object
5 properties
1 required
ConnectRequest
object
5 properties
4 required
MergeUserConflict
object
Contains a merge conflict between two users with different values for the same user field data
3 properties
3 required
BaseUser
object
33 properties
2 required
HCaptchaSettings
object
3 properties
GlobalWalletConnectionCreateRequest
object
1 property
1 required
WalletBitcoinConfig
object
2 properties
TransferDestinationList
array
EncodedJwt
string
Encoded JWT token. This will only be returned when cookie-based authentication is disabled in favor of standard Auth header based authentication.
Asset
object
8 properties
7 required
SignMessageAuthorizationSignature
object
Authorization signature data (optional)
7 properties
UpdateWaasWalletSettingsResponse
object
2 properties
2 required
ecdsaValidatorOptions
string
VerifyUnlinkRequest
object
4 properties
PublicKeyCredentialType
string
DelegatedShareDeliveryRequest
object
1 property
1 required
PasskeyCredentialHint
string
NetworkConfigurationResponse
object
2 properties
UnprocessableEntityErrorPayload
object
Contains information which the integrating client of this API can use to tailor an experience to a customer to fix the underlying issue that triggered this err…
6 properties
SocialSignInProvider
object
2 properties
1 required
AssetTransfer
object
4 properties
SsoProviderCheckResponse
object
4 properties
1 required
CustomFieldValidValue
object
2 properties
1 required
WalletConnectorKey
string
TelegramUser
object
7 properties
3 required
ChainConfiguration
object
3 properties
3 required
kdaWalletString
stringnull
KDA wallet address
ResidentKeyRequirement
string
NonEmptyAmountString
string
Digits with optional decimal part
ThresholdSignatureScheme
string
AssetExposure
object
2 properties
2 required
emailOrEmptyString
string
PublicKeyCredentialDescriptor
object
2 properties
2 required
UserFieldsCheckResponse
object
3 properties
3 required
WalletTransactionType
string
MFAUpdateDeviceRequest
object
1 property
1 required
TurnkeyWalletProperties
object
10 properties
TurnkeyStamp
object
2 properties
2 required
MFAAuthRecoveryDevicePostRequest
object
2 properties
1 required
EmbeddedWalletProviderEnum
string
Values 'turnkey' and 'turnkeyhd' are deprecated and will be removed in a future version.
SdkView
object
Configs used to create the view in the sdk.
2 properties
1 required
TurnkeyDeleteEmbeddedWalletsRequestBodyParameters
object
2 properties
1 required
ProjectSettingsGeneral
object
11 properties
CustomFieldValidationRules
object
Optional validation rules for the custom field
4 properties
Unauthorized
object
1 property
WalletTransactionsResponse
object
2 properties
1 required
CoinbaseOnrampGetBuyUrlRequest
object
13 properties
2 required
InternalServerError
object
1 property
JwtVerifiedCredential
object
28 properties
3 required
CreateRoomsWithoutWalletIdResponse
object
1 property
1 required
OauthRequest
object
6 properties
1 required
UpgradeEmbeddedWalletToV2Request
object
1 property
CoinbaseOnrampFee
object
3 properties
3 required
ProjectSettingsKyc
object
10 properties
5 required
EmailVerificationCreateResponse
object
2 properties
2 required
CreateRoomsResponse
object
1 property
1 required
InitEmailAuthRequest
object
2 properties
2 required
EmbeddedWalletChainEnum
string
SignMessageSuiTransaction
object
Sui BCS serialized transaction as hex string
2 properties
2 required
GlobalWalletConnection
object
7 properties
5 required
TelegramPostRequest
object
2 properties
2 required
BackupKeySharesToLocationsRequest
object
1 property
1 required
UserFields
object
23 properties
CoinbaseOnrampOrderStatus
string
The status of an onramp order.
ExchangeRatesResponse
array
CreateEmbeddedWalletSpecificOpts
VerifyRequest
object
15 properties
6 required
ErrorMessageWithCode
object
2 properties
Eip712Domain
object
4 properties
EmailVerificationRetryRequest
object
3 properties
2 required
SmsVerificationVerifyRequest
object
4 properties
2 required
ReactSettings
object
1 property
WalletProviderEnum
string
MergeUserConflictResolutions
object
Contains the resolutions for merging two users
1 property
EmbeddedWalletAuthToken
object
1 property
1 required
ScanWebsiteUrlRequest
object
1 property
1 required
JwksResponse
object
1 property
1 required
PrefetchRequest
object
2 properties
2 required
OAuthCode
string
Valid oauth code
NonEmptyStringWith16384MaxLength
string
A string with a max length of 16384 characters
FarcasterSignInRequest
object
7 properties
5 required
NativeCurrency
object
6 properties
3 required
OauthResultRequest
object
6 properties
EthSolBtcSuiFlowCosmosTronWalletAddress
string
Valid Eth, Solana, Btc, Sui, Flow, Cosmos, and TRON wallet addresses
CoinbaseOnrampGetBuyUrlResponse
object
1 property
1 required
PasskeyRegistrationCredential
object
5 properties
4 required
ProjectSettingsDesignWidget
object
5 properties
Provider
object
41 properties
1 required
MFASettings
object
5 properties
ProjectSettingsDesignButton
object
5 properties
WalletKeyShareInfo
object
4 properties
3 required
BackupKeySharesToLocationResponse
object
3 properties
3 required
FeatureFlags
object
2 properties
2 required
EmailVerificationMfaRequest
object
3 properties
2 required
ImportWaasPrivateKeyRequest
object
4 properties
3 required
NetworkConfiguration
object
19 properties
9 required
UnprocessableEntityErrorCode
string
Funding
object
2 properties
1 required
TokenBalance
object
13 properties
7 required
OptionalNonEmptyUrl
string
SupportedOfframpsResponse
object
1 property
RampConfiguration
object
5 properties
4 required
HardwareWalletProperties
object
1 property
Duration
object
2 properties
2 required
ProjectSettingsChains
object
3 properties
2 required
ScanWebsiteUrlResponse
object
1 property
PublishEvents
object
1 property
1 required
Account
object
6 properties
3 required
RecoverMultipleClientKeySharesRequest
object
1 property
TurnkeyWalletAccount
object
4 properties
4 required
AttestationConveyancePreference
string
SdkViewSectionType
string
WalletKeyShareInfoWithEncryptedAccountCredential
object
ProjectSettingsGeneralApps
object
CreateExchangeTransferRequest
object
8 properties
3 required
MergeConflicts
object
Contains information needed for the SDK to surface merge conflicts when attempting to merge information from one user to another
2 properties
2 required
RoomCount
integer
Number of rooms to create
GeneratedTokenResponse
object
1 property
1 required
MultichainAccountBalancesRequest
object
2 properties
1 required
ProviderKernelVersionEnum
string
SignMessageEvmUserOperation
object
User Operation (ERC-4337)
3 properties
kasWalletString
stringnull
KAS wallet address
PasskeyRegisterRequest
object
7 properties
5 required
SupportedSecurityMethods
object
3 properties
PasskeyAuthRequest
object
7 properties
5 required
AuthenticationExtensionsClientInputs
object
3 properties
SimulateTransactionResponse
object
7 properties
4 required
DelegatedShareDeliveryResponse
object
3 properties
2 required
ltcWalletString
stringnull
LTC wallet address
CompletePasskeyRecoveryRequest
object
3 properties
3 required
RegisterSessionKeyRequest
object
3 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Dynamic publishes across the network.