Data Types

Configuration

ClientProps

Configuration object for initializing the Dynamic SDK.

data class ClientProps(
    val environmentId: String,                              // Your Dynamic environment ID (required)
    val apiBaseUrl: String? = "https://app.dynamicauth.com/api/v0",
    val appLogoUrl: String? = null,
    val appName: String = "Dynamic",
    val redirectUrl: String? = null,
    val appOrigin: String? = null,
    val cssOverrides: String? = null,
    val debugWebview: Boolean = false,
    val logLevel: LoggerLevel = LoggerLevel.INFO,
    val debug: ClientDebugProps? = null,
    val evmNetworks: List<GenericNetwork>? = null,
    val reownProjectId: String? = null,
    val deviceRegistrationModal: DeviceRegistrationModal? = null
)

Properties

Property	Type	Required	Description
environmentId	String	Yes	Your Dynamic environment ID from the dashboard
apiBaseUrl	String?	No	Override the Dynamic API base URL
appLogoUrl	String?	No	URL to your app’s logo (shown in auth UI)
appName	String	No	Your app’s display name (defaults to "Dynamic")
redirectUrl	String?	No	Deep link URL scheme for callbacks (e.g., yourapp://)
appOrigin	String?	No	Your app’s origin URL
cssOverrides	String?	No	CSS string injected into the webview to override default styles
debugWebview	Boolean	No	Enable WebView debugging
logLevel	LoggerLevel	No	Logging level (DEBUG, INFO, WARN, ERROR)
debug	ClientDebugProps?	No	Debug options
evmNetworks	List<GenericNetwork>?	No	Custom EVM networks
reownProjectId	String?	No	Reown (WalletConnect) project ID
deviceRegistrationModal	DeviceRegistrationModal?	No	Controls the device registration modal behavior

Example

import com.dynamic.sdk.android.DynamicSDK
import com.dynamic.sdk.android.core.ClientProps
import com.dynamic.sdk.android.core.LoggerLevel

val props = ClientProps(
    environmentId = "YOUR_ENV_ID",
    appLogoUrl = "https://your-app.com/logo.png",
    appName = "Your App Name",
    redirectUrl = "yourappscheme://",
    appOrigin = "https://your-app.com",
    cssOverrides = ".wallet-list-item__tile { background-color: lightblue; }",
    logLevel = LoggerLevel.DEBUG
)

DynamicSDK.initialize(props, applicationContext, this)

ClientDebugProps

Debug configuration options.

data class ClientDebugProps(
    val webview: Boolean = false,
    val messageTransport: Boolean = false,
    val loggerLevel: Int? = null
)

Properties

• webview (Boolean): Log webview messages
• messageTransport (Boolean): Log message transport events
• loggerLevel (Int?): Override the logger level by numeric value

DeviceRegistrationModal

Controls whether the device registration modal is shown automatically.

data class DeviceRegistrationModal(
    val enabled: Boolean = true
)

Properties

• enabled (Boolean): When false, the SDK does not show the device registration modal automatically

Authentication

UserProfile

Represents an authenticated user’s profile.

data class UserProfile(
    val userId: String?,
    val email: String?,
    val phoneNumber: String?,
    // Additional fields available
)

Example

val user = sdk.auth.authenticatedUser
if (user != null) {
    println("User ID: ${user.userId}")
    println("Email: ${user.email}")
    println("Phone: ${user.phoneNumber}")
}

PhoneData

Phone number data for SMS authentication.

data class PhoneData(
    val dialCode: String,   // e.g., "+1"
    val iso2: String,       // e.g., "US"
    val phone: String       // Phone number without country code
)

Example

val phoneData = PhoneData(
    dialCode = "+1",
    iso2 = "US",
    phone = "5551234567"
)

sdk.auth.sms.sendOTP(phoneData)

SignInWithExternalJwtParams

Parameters for external JWT authentication.

data class SignInWithExternalJwtParams(
    val jwt: String     // The external JWT token
)

Example

sdk.auth.externalAuth.signInWithExternalJwt(
    SignInWithExternalJwtParams(jwt = "your-jwt-token")
)

Wallets

BaseWallet

Represents a user’s wallet.

data class BaseWallet(
    val address: String,        // Wallet address
    val chain: String,          // "EVM" or "SOL"
    val walletName: String?,    // Wallet name (optional)
    val id: String?             // Wallet ID for API operations (optional)
)

Example

val wallets = sdk.wallets.userWallets
wallets.forEach { wallet ->
    println("Address: ${wallet.address}")
    println("Chain: ${wallet.chain}")
    println("Name: ${wallet.walletName}")
    println("ID: ${wallet.id}")
}

GenericNetwork

Represents a blockchain network.

data class GenericNetwork(
    val name: String,
    val chainId: Any?,      // For EVM networks
    val networkId: Any?     // For Solana networks
    // Additional fields: rpcUrls, blockExplorerUrls, nativeCurrency, ...
)

Example

val evmNetworks = sdk.networks.evm
val ethereum = evmNetworks.first { it.chainId == 1 }
println("Network: ${ethereum.name}, Chain ID: ${ethereum.chainId}")

val solanaNetworks = sdk.networks.solana
val mainnet = solanaNetworks.first { it.networkId == "mainnet-beta" }
println("Network: ${mainnet.name}, Network ID: ${mainnet.networkId}")

EVM / Blockchain

EthereumTransaction

Transaction data for EVM chains.

data class EthereumTransaction(
    val from: String,                   // Sender address
    val to: String? = null,             // Recipient address
    val value: BigInteger? = null,      // Amount in Wei
    val data: String? = null,           // Contract data (optional)
    val gas: BigInteger? = null,        // Gas limit (optional)
    val gasPrice: BigInteger? = null,   // Gas price (optional)
    val maxFeePerGas: BigInteger? = null,      // Max fee per gas (optional)
    val maxPriorityFeePerGas: BigInteger? = null, // Priority fee (optional)
    val nonce: Int? = null              // Nonce (optional)
)

Example

val transaction = EthereumTransaction(
    from = wallet.address,
    to = "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    value = BigInteger("1000000000000000"), // 0.001 ETH in Wei
    gas = BigInteger.valueOf(21000),
    maxFeePerGas = BigInteger("30000000000"),
    maxPriorityFeePerGas = BigInteger("2000000000")
)

WriteContractInput

Input for writing to a smart contract.

data class WriteContractInput(
    val address: String,                // Contract address
    val abi: List<Map<String, Any>>,    // Contract ABI
    val functionName: String,           // Function to call
    val args: List<Any>                 // Function arguments
    // Optional gas/value fields: gas, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, value
)

Example

val input = WriteContractInput(
    address = "0x...",
    functionName = "transfer",
    args = listOf("0x...", "1000000000000000000"), // recipient, amount
    abi = parseAbiJson(Erc20.abi)
)

EstimatedFeesPerGas

Estimated fee information for EVM chains, returned by sdk.evm.estimateFeesPerGas.

data class EstimatedFeesPerGas(
    val maxFeePerGas: BigInteger,
    val maxPriorityFeePerGas: BigInteger,
    val gasPrice: BigInteger
)

Example

val client = sdk.evm.createPublicClient(chainId = 1)
val gasPrice = client.getGasPrice()  // BigInteger, in Wei
println("Gas price: $gasPrice")

Erc20

ERC20 token utilities.

object Erc20 {
    val abi: String  // Standard ERC20 ABI as JSON string
}

Example

// Parse ERC20 ABI for contract interactions
val abiList = parseAbiJson(Erc20.abi)

Blockhash

Solana blockhash information, from the sol4k-based solana-web3.aar.

// com.solanaweb3.Blockhash
data class Blockhash(
    val blockhash: String,
    val lastValidBlockHeight: Long?
)

Example

import com.solanaweb3.Connection
import com.solanaweb3.Cluster

val connection = Connection(Cluster.DEVNET)
val result = connection.getLatestBlockhash()
println("Blockhash: ${result.blockhash}")
println("Valid until block: ${result.lastValidBlockHeight}")

MFA

MfaDevice

Represents an MFA device.

data class MfaDevice(
    val id: String?,
    val type: MfaDeviceType?
)

enum class MfaDeviceType {
    totp
}

Example

val devices = sdk.mfa.getUserDevices()
devices.forEach { device ->
    println("Device ID: ${device.id}")
    println("Type: ${device.type?.name}")
}

MfaAddDevice

Response when adding an MFA device.

data class MfaAddDevice(
    val secret: String,     // Secret for QR code generation
    val id: String?
)

Example

val device = sdk.mfa.addDevice("totp")
println("Secret for QR code: ${device.secret}")
// Display QR code with this secret for user to scan

MfaAuthenticateDevice

Parameters for authenticating an MFA device.

data class MfaAuthenticateDevice(
    val code: String,
    val deviceId: String,
    val createMfaToken: MfaCreateToken
)

Example

val token = sdk.mfa.authenticateDevice(
    MfaAuthenticateDevice(
        code = "123456",
        deviceId = "device-id",
        createMfaToken = MfaCreateToken(singleUse = true)
    )
)

MfaCreateToken

Parameters for MFA token creation.

data class MfaCreateToken(
    val singleUse: Boolean
)

Example

val createToken = MfaCreateToken(singleUse = true)

Passkeys

UserPasskey

Represents a user’s passkey.

data class UserPasskey(
    val id: String,
    val createdAt: String,      // ISO format
    val lastUsedAt: String?,    // ISO format (optional)
    val isDefault: Boolean?
)

Example

val passkeys = sdk.passkeys.getPasskeys()
passkeys.forEach { passkey ->
    println("ID: ${passkey.id}")
    println("Created: ${passkey.createdAt}")
    println("Last used: ${passkey.lastUsedAt}")
    println("Is default: ${passkey.isDefault}")
}

DeletePasskeyRequest

Request to delete a passkey.

data class DeletePasskeyRequest(
    val passkeyId: String
)

Example

sdk.passkeys.deletePasskey(
    DeletePasskeyRequest(passkeyId = "passkey-id")
)

PasskeyAuthenticationResponse

Response from passkey MFA authentication.

data class PasskeyAuthenticationResponse(
    val jwt: String?    // MFA token
)

Example

val response = sdk.passkeys.authenticatePasskeyMFA(
    createMfaToken = MfaCreateToken(singleUse = true),
    relatedOriginRpId = null
)
println("MFA Token: ${response.jwt}")

Error Handling

All SDK methods that can fail will throw exceptions. Use standard Kotlin error handling:

try {
    sdk.auth.email.verifyOTP(code)
} catch (e: Exception) {
    Log.e("SDK", "Error: ${e.message}")
}

For suspend functions in coroutines:

viewModelScope.launch {
    try {
        val wallets = sdk.wallets.userWallets
    } catch (e: Exception) {
        errorMessage.value = "Failed: ${e.message}"
    }
}