References
Enumerations
| Enumeration | Description |
|---|---|
| CryptoErrorType | Error types for cryptographic operations. |
| IFrameApiErrorType | Error types for iframe API integration. |
| JwtErrorType | Error types for JWT handling and validation. |
| SdkErrorTypes | Enum representing all possible SDK error types. |
Classes
| Class | Description |
|---|---|
| CryptoError | Error thrown when a cryptographic operation fails. |
| IFrameApiError | Error thrown by the iframe API server/client layer. |
| JwtError | Error thrown when JWT validation fails or a token is malformed. |
| KeybanAccount | Abstract account bound to a specific chain implementation (EVM, Starknet, Stellar). Provides methods to sign messages and to transfer/estimate fees for native currency, ERC‑20-like tokens, and NFTs, when supported by the target network. Obtain an instance via KeybanClient.initialize. |
| KeybanBaseError | The KeybanBaseError class serves as the foundational structure for all custom errors within the Keyban SDK. It extends the native JavaScript Error class, providing additional properties to enrich error handling with more context and information. |
| KeybanClient | Main client for interacting with the Keyban API and associated services. This class provides methods to initialize accounts, retrieve balances, query NFTs, and interact with the Keyban blockchain. |
| SdkError | Class representing an SDK-specific error. |
Interfaces
| Interface | Description |
|---|---|
| ClientShareProvider | Represents a storage provider for the client share. |
| IAccountService | Account service. |
| IApplicationService | Application service. |
| IAuthService | Authentication service. |
| IClientShareStorageService | Storage for persisting and retrieving the MPC client share on the integrator side. |
| IDppService | Digital Product Passport (DPP) operations. |
| IKeybanApi | Aggregated API surface exposed through the iframe transport. |
| ILoyaltyService | Loyalty operations for wallet passes and tier retrieval. |
| ISignerService | MPC signer for a given curve (ECDSA/EdDSA). |
| KeybanInputRef | Ref interface for KeybanInput component. Provides imperative methods to control the input. |
Type Aliases
| Type Alias | Description |
|---|---|
| Account | Complete on-chain account information returned by the Keyban API. |
| AccountAssignment | Pending loyalty assignment created before an account exists. |
| Address | Represents an Ethereum address in hexadecimal format. |
| ApiResult | A tuple representing the result of an API call to the Keyban servers. |
| Application | Application configuration and metadata. |
| ApplicationFeature | String literal union of the supported application features. |
| ApplicationThemeMode | String literal union describing the theme mode options. |
| AuthConnection | Represents the types of authentication connections available. |
| AuthContext | Represents the authentication context, extending the base authentication state with loading status and methods for various login/logout flows. |
| AuthMethod | - |
| AuthSendOtpArgs | Arguments for sending a One-Time Password (OTP). |
| AuthSignInArgs | Arguments for signing in a user. |
| AuthUpdateUserArgs | - |
| AuthUser | Authenticated user profile. |
| Balance | Represents a balance with optional metadata. |
| BaseAuth | Represents the authentication state of the user. |
| ChatRole | - |
| CreateInvestFund | - |
| Currency | String literal union of supported loyalty currencies. |
| DppApplicationMetrics | DPP metrics for a specific application. |
| DppClaimResult | Result of a DPP claim operation. |
| DppMetrics | DPP metrics for tracking Digital Product Passport lifecycle. |
| DppMetricsByOrg | DPP metrics grouped by organization. |
| DppPassport | - |
| DppProduct | Product template for Digital Product Passports. |
| DppProductStatus | String literal union of the DPP product statuses. |
| DynamicFieldDef | - |
| DynamicFieldsType | - |
| DynamicFieldType | - |
| EstimateERC20TransferParams | Parameters to estimate an ERC‑20 transfer, without fees. Derived from TransferERC20Params by omitting fees. |
| EstimateNftTransferParams | Parameters to estimate an NFT transfer, without fees. Derived from TransferNftParams by omitting fees. |
| EvmFeeDetails | EIP‑1559 fee parameters for EVM transactions. Used by EVM account transfer methods to override gas pricing when needed. |
| EvmNetwork | Allowed EVM network identifiers. |
| FeeDetails | - |
| FeesEstimation | Represents a transaction fee estimation returned by estimation methods. The concrete shape of the details field depends on the underlying network: - EVM chains: EvmFeeDetails (EIP-1559 fields) - Stellar: StellarFeeDetails (fee per operation as string) |
| FeesUnit | Represents the unit of fees in a specific blockchain. |
| FormatedBalanceProps | Props for the FormattedBalance component. |
| GoogleGeminiModel | - |
| GqlEdge | - |
| GqlPaginatedData | - |
| Hash | Represents a cryptographic hash value in hexadecimal format. |
| Hex | Represents a hexadecimal value in blockchain-related contexts. |
| InvestFund | Investment fund definition. |
| InvestFundStatus | String literal union of the invest fund statuses. |
| KeybanApiStatus | - |
| KeybanAssetTransfer | - |
| KeybanClientConfig | Configuration options for initializing the Keyban client. |
| KeybanInputProps | Props for the KeybanInput component. |
| KeybanNft | - |
| KeybanNftBalance | - |
| KeybanOrder | - |
| KeybanProviderProps | Defines the properties for the KeybanProvider component. |
| KeybanToken | - |
| KeybanTokenBalance | - |
| LlmModelPricing | - |
| LlmProvider | - |
| LlmUsageByModel | - |
| LlmUsageByOrganization | - |
| LlmUsageByProvider | - |
| LlmUsageMeta | - |
| LlmUsageMetadata | - |
| LlmUsageRecord | - |
| LlmUsageResponse | - |
| LlmUsageTimeline | - |
| LoyaltyApplicationMetrics | Loyalty metrics for a specific application. |
| LoyaltyMetrics | Loyalty metrics for tracking program engagement and customer behavior. |
| LoyaltyMetricsByOrg | Loyalty metrics grouped by organization. |
| LoyaltyRewardTier | Loyalty reward tier definition. |
| NativeCurrency | Represents the native currency of a blockchain network. |
| Network | Union across every supported blockchain runtime. |
| ObjectEnum | - |
| ObjectPaths | - |
| Order | - |
| OrderItem | - |
| Organization | - |
| PaginatedData | An object representing a paginated data API result. |
| PaginationArgs | Arguments for paginating a collection. |
| PaginationExtra | An object allowing extra interactions with the Keyban API. |
| Prettify | - |
| ProblemDetails | RFC 7807 Problem Details for HTTP APIs. |
| ProductDetailStats | Detailed statistics for a DPP product sheet. |
| ProductStats | Aggregated statistics for all DPP product sheets at organization level. |
| QuotaEntity | - |
| QuotaOperation | - |
| QuotaOrganization | - |
| QuotaUsage | - |
| ShopifyPassportFields | - |
| ShopifyProductFields | - |
| ShopifyShop | - |
| StarknetNetwork | Allowed Starknet network identifiers. |
| StellarFeeDetails | Stellar fee per operation represented as a string in stroops. In congestion, Horizon exposes a higher mode fee; otherwise it's the base fee (100 stroops). |
| StellarNetwork | Allowed Stellar network identifiers. |
| TierDistribution | Tier distribution representing customer spread across loyalty tiers. |
| TimeSeriesDataPoint | Time series data point for tracking product sheet creation trends over time. |
| TransferERC20Params | Parameters for transferring ERC‑20-like fungible tokens. |
| TransferNftParams | Parameters for transferring NFTs (ERC‑721 / ERC‑1155 on EVM chains). |
| UpdateInvestFund | - |
Variables
| Variable | Description |
|---|---|
| ApplicationFeature | Flags describing which product surfaces (DPP, Loyalty, or Invest) are enabled for a given application. Used throughout the SDK to flip UI and API capabilities. |
| ApplicationThemeMode | Enumerates the supported UI presentation modes for hosted applications. Typedoc consumers rely on this union to toggle light/dark specific assets. |
| AuthMethod | - |
| ChatRole | Chat message role |
| Currency | Limited list of fiat currencies supported by the loyalty engine for point accrual and redemption calculations. |
| DppProductStatus | Workflow states describing where a Digital Product Passport sheet sits in the publication lifecycle. |
| EvmNetwork | Canonical blockchain network identifiers supported by Keyban across EVM, Starknet, and Stellar stacks. These unions align with backend configuration keys and Tilt profiles to prevent drift. |
| GoogleGeminiModel | Google Gemini models supported in MVP Note: Gemini 1.5 models were retired in 2025, using 2.5 series |
| InvestFundStatus | Status of an investment fund in the platform lifecycle. |
| KeybanInput | KeybanInput renders a secure iframe-based input component for the Keyban SDK client. This component provides a secure way to handle sensitive user inputs like emails, phone numbers, passwords, and OTP codes by isolating them in a sandboxed iframe. |
| LlmProvider | Supported LLM providers |
| Network | Normalized lookup that collapses duplicated enum values (e.g. both Starknet/Stellar define Mainnet) into a single Record consumable by Zod. |
| QuotaEntity | - |
| QuotaOperation | - |
| StarknetNetwork | - |
| StellarNetwork | - |
Functions
| Function | Description |
|---|---|
| formatBalance | Format a balance using the client's native/fee units or the token metadata. |
| FormattedBalance | A React component that formats and displays a balance. |
| KeybanProvider | Provider component for the Keyban SDK. This component wraps the application and provides Keyban SDK functionalities to the components within the application. It is responsible for configuring the Keyban client with the appropriate options and ensuring that the SDK is accessible via the useKeybanClient hook. |
| useFormattedBalance | Formats a balance in a human-readable format using the Keyban client. This is typically used to display the balance of an account, as retrieved by |
| useKeybanAccount | Retrieves the current KeybanAccount associated with the Keyban client. |
| useKeybanAccountBalance | Hook to retrieve and subscribe to the balance of a Keyban account. |
| useKeybanAccountNft | The useKeybanAccountNft React hook allows you to fetch the balance of a specific NFT (ERC721 or ERC1155) owned by a Keyban account. It provides detailed information about the NFT, including metadata and collection details, offering a reactive and easy-to-use interface within functional components. |
| useKeybanAccountNfts | Returns an ApiResult of the NFTs of an account. |
| useKeybanAccountOrders | Returns an ApiResult tuple for the orders history of an account. |
| useKeybanAccountTokenBalance | The useKeybanAccountTokenBalance React hook allows you to fetch the balance of a specific token (ERC20) owned by a Keyban account. It provides detailed information about the token, including metadata and collection details, offering a reactive and easy-to-use interface within functional components. |
| useKeybanAccountTokenBalances | Returns an ApiResult of the ERC20 tokens of an account. |
| useKeybanAccountTransferHistory | Returns an ApiResult tuple for the transfer history of an account. |
| useKeybanApplication | Retrives application details. |
| useKeybanAuth | Custom hook to access the Keyban authentication context. |
| useKeybanClient | Hook to access the Keyban SDK functionalities within a React component. |
| useKeybanNft | Retrives a single nft data. |
| useKeybanPassport | Retrives a single product. |
| useKeybanPassportToken | Retrives a single passport token. |
| useKeybanProduct | Retrives a single product. |
| useLoyaltyOptimisticBalance | Retrieves the current optimisticBalance associated with the Keyban client. |