| 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. |
| AgentWallet | - |
| AgentWalletStatus | String literal union of the agent wallet lifecycle statuses. |
| ApiResult | A tuple representing the result of an API call to the Keyban servers. |
| Application | Application configuration and metadata. |
| ApplicationEventType | - |
| 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 | - email-otp: Authentication via a one-time password sent to the user's e-mail address. - phone-otp: Authentication via a one-time password sent by SMS to the user's phone number. - google: Authentication delegated to Google OAuth 2.0 / Sign-in with Google. - auth0: Authentication delegated to an Auth0 tenant (used for enterprise SSO and legacy flows). |
| 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. |
| CertificationKeyHistoryItem | Historical certification key item. Includes status, activation dates, and registered networks. |
| CertificationKeyResponse | Certification key response with on-chain registration status. Includes registration status, registered networks, and rotation progress. |
| CertificationKeyStatus | Certification key status enum. - active: Currently used for signing - pending: Awaiting on-chain rotation to complete - rotated: Replaced by a newer key, kept for verification - revoked: Compromised or manually revoked |
| ChargebeeFeature | Stable Chargebee feature IDs mapped to platform quota controls; also used as i18n translation keys on the frontend. |
| ChatRole | Chat message role |
| CreateAgentWallet | - |
| CreateInvestFund | - |
| CreateInvestIdentity | - |
| CreateInvestLockup | - |
| CreateInvestNav | - |
| CreateInvestOffer | - |
| CreateSigner | - |
| Currency | Fiat currencies supported by the loyalty engine for point accrual and redemption calculations (ISO 4217). |
| DppAction | - |
| DppActions | - |
| DppApplicationMetrics | DPP metrics for a specific application. |
| DppCertificationStatus | - |
| DppClaimResult | Result of a DPP claim operation. |
| DppMetrics | DPP metrics for tracking Digital Product Passport lifecycle. |
| DppMetricsByOrg | DPP metrics grouped by organization. |
| DppPassport | - |
| DppPassportBatch | - |
| DppPassportEventType | - |
| DppPassportGranularity | - model: One passport is shared across all units of a product reference (model-level traceability). - batch: One passport per production batch, grouping multiple units produced together. - item: One passport per individual physical unit (serialised traceability, highest granularity). |
| DppPassportItem | - |
| DppPassportModel | - |
| DppPassportStatus | String literal union of the DPP passport lifecycle 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. |
| Event | - |
| EventSubject | The domain entity that an audit/quota event targets. |
| EventType | The type of audit/quota event. |
| 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 | Google Gemini models supported in MVP Note: Gemini 1.5 models were retired in 2025, using 2.5 series |
| GqlEdge | - |
| GqlPaginatedData | - |
| Hash | Represents a cryptographic hash value in hexadecimal format. |
| Hex | Represents a hexadecimal value in blockchain-related contexts. |
| ImportJob | - |
| ImportJobProgress | - |
| ImportJobReport | - |
| ImportJobSource | - upload: The import job was triggered by a user uploading a file (CSV/Excel) through the admin interface. - shopify: The import job was triggered by a Shopify product catalogue synchronisation. |
| InvestFund | Investment fund definition. |
| InvestFundStatus | Status of an investment fund through its lifecycle. |
| InvestHolding | Holding record representing the shares held by an investor in a fund. |
| InvestIdentity | Investor identity with KYC lifecycle tracking. |
| InvestIdentityStatus | KYC verification status of an investor identity. |
| InvestLockup | Custom lockup period for an investor in a specific fund. |
| InvestNav | NAV (Net Asset Value) record for an investment fund. |
| InvestOffer | Secondary market offer for an investment fund. |
| InvestOfferStatus | String literal union of the invest offer statuses. |
| InvestOfferType | String literal union of the invest offer types. |
| JobStatus | String literal union of the BullMQ job 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 | Supported LLM providers |
| 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 | - |
| Module | - |
| NativeCurrency | - |
| Network | Union across every supported blockchain runtime. |
| ObjectEnum | - |
| ObjectPaths | - |
| OnChainStatus | On-chain certifier status. - registered: Key is registered and valid on at least one network - pending: Key exists but not yet registered on-chain |
| Order | - |
| OrderItem | - |
| Organization | - |
| OrganizationQuotas | - |
| 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. |
| Permission | - |
| Permissions | - |
| Plan | - |
| PlanFeature | - |
| PlanPrice | - |
| Prettify | - |
| ProblemDetails | RFC 7807 Problem Details for HTTP APIs. |
| QuotaUsage | - |
| RotateCertificationKeyResponse | Response from the certification key rotation endpoint. Includes new key details and number of on-chain rotation jobs queued. |
| ShopifyPassportFields | - |
| ShopifyProductFields | - |
| ShopifyShop | - |
| Signer | - |
| SignerRelayParams | Parameters for ISignerService.relay. |
| SignerStatus | String literal union of the signer lifecycle statuses. |
| SignerType | - agentic: Backend-controlled account using MPC/TSS; the private key is never exposed to the end user. |
| StarknetFeeDetails | Starknet v3 transaction fee parameters using resource bounds. Contains gas limits and prices for l2_gas, l1_gas, and l1_data_gas. |
| StarknetNetwork | Allowed Starknet network identifiers. |
| Statements | - |
| 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. |
| TransferERC20Params | Parameters for transferring ERC‑20-like fungible tokens. |
| TransferNftParams | Parameters for transferring NFTs (ERC‑721 / ERC‑1155 on EVM chains). |
| UpdateAgentWallet | - |
| UpdateInvestFund | - |
| UpdateInvestIdentity | - |
| UpdateInvestLockup | - |
| UpdateInvestOffer | - |
| UpdateSigner | - |
| WalletEventType | - |