| Account | Complete on-chain account information returned by the Keyban API. |
| AccountAssignment | Pending loyalty assignment created before an account exists. |
| AcquisitionChannel | Third-party platform through which an organization was acquired (the "install a Keyban plugin" funnel). Non-secret attribution tag, set from the ?source= query param at free-plan signup. |
| Address | Represents an Ethereum address in hexadecimal format. |
| AgentWallet | - |
| AgentWalletBudget | - |
| AgentWalletStatus | String literal union of the agent wallet lifecycle statuses. |
| ApiErrorCode | Stable, versioned error codes carried by RFC 7807 responses (problem-details.ts, field code). The code never changes once shipped; clients map it to a localized message via their own catalog and fall back to the English detail when unknown. Only errors that can reach a browser UI (admin, dpp consumer) carry a code — backend-only failures (5xx, device callbacks) leave it undefined. |
| Application | Application configuration and metadata. |
| ApplicationEventType | - |
| ApplicationFeature | String literal union of the supported application features. |
| ApplicationThemeMode | String literal union describing the theme mode options. |
| AudiencePreview | Estimated reach of a campaign targeting filter, returned by the audience-preview endpoint. fullAvailabilityAt is an RFC 3339 string (the serialized network shape); counts are over the opted-in audience only. |
| AuthConnection | Represents the types of authentication connections available. |
| 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. |
| Campaign | Wallet marketing campaign (Google/Apple notification push to loyalty cards). |
| CampaignContent | Single message (headline + body) persisted on the campaign (JSONB column). |
| CampaignStats | Aggregated outcome of a campaign once it has started sending, returned by the campaign stats endpoint: a per-status delivery tally plus a revenue-free conversion proxy. Computed live, so figures keep moving until the campaign is finished; all zero before sending starts. |
| CampaignStatus | Lifecycle status of a marketing campaign. |
| CampaignTargeting | Audience filter shape persisted on the campaign (JSONB column). |
| 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 |
| ConsentDecision | A customer's current marketing-consent decision for one application, as read/written through the self-service consent endpoint. Tri-state: true = consented, false = refused, null = no decision yet or withdrawn. |
| ConsentLogEntry | One immutable entry of a customer's consent history for a given application and purpose (GDPR proof of consent, art. 7.1), returned by the consent-log endpoint, newest first. |
| CreateAgentWallet | - |
| CreateImportMapper | Body shape for creating an import mapper. |
| CreateInvestFund | - |
| CreateInvestIdentity | - |
| CreateInvestLockup | - |
| CreateInvestNav | - |
| CreateInvestOffer | - |
| CreateSigner | - |
| Currency | Fiat currencies supported by the loyalty engine for point accrual and redemption calculations (ISO 4217). |
| DidDocumentResponse | W3C DID Document a tenant publishes at https://{domain}/.well-known/did.json so external verifiers can resolve did:web:{domain} and validate VC signatures without contacting Keyban. |
| DidWebConfigResponse | Response for GET / PUT /v1/dpp/certification-key/did-web-config. didDocument is null when the tenant has not configured a did:web domain. |
| DppAction | - |
| DppActions | - |
| DppActionType | - |
| DppApplicationMetrics | DPP metrics for a specific application. |
| DppCertificationStatus | - |
| DppCharacteristicProvenance | - |
| DppCharacteristicProvenanceRecord | - |
| DppCharacteristicProvenanceStatus | Review status of an AI-extracted characteristic (Trust structuration). |
| DppCharacteristicReviewEntry | - |
| DppClaimResult | Result of a DPP claim operation. |
| DppMetrics | DPP metrics for tracking Digital Product Passport lifecycle. |
| DppMetricsByOrg | DPP metrics grouped by organization. |
| DppPassport | - |
| DppPassportEvent | - |
| DppPassportEventType | - |
| DppPassportStatus | String literal union of the DPP passport lifecycle statuses. |
| DppSource | - manual: The DPP passport was created by hand through the admin interface. - import: The passport was created via a bulk file import job (CSV/Excel upload). - shopify: The passport was automatically created from a Shopify product synchronisation. |
| DppUncpc | - |
| DppVcStatusState | Derived lifecycle state of a passport's Verifiable Credential, surfaced for the consumer-facing VC banner (epic #4155). |
| 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 | - |
| Event_Application | - |
| Event_DppPassport | - |
| Event_Wallet | - |
| 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. |
| ExchangeRateAsset | String literal union of the quotable on-chain assets. |
| ExchangeRateConversion | - |
| 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. |
| GoogleGeminiModel | Google Gemini models supported in MVP Note: Gemini 1.5 models were retired in 2025, using 2.5 series |
| Hash | Represents a cryptographic hash value in hexadecimal format. |
| Hex | Represents a hexadecimal value in blockchain-related contexts. |
| ImportJob | - |
| ImportJobBatch | - |
| ImportJobEntity | - |
| ImportJobProgress | - |
| 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. - scheduled: The import job was triggered by a url mapper's recurring CRON fetch — no user interaction. |
| ImportMapper | An import mapper: an ordered list of field mappings used to transform an imported JSON payload into a target model. |
| ImportMapperDestinationField | A field an import-mapper row can write to, as a dot-path into the passport-creation input (e.g. product.name). required marks fields the input schema makes mandatory — the mapper form seeds a locked row for each. enumValues is set for fields tagged enumSelect on the schema: their value is constrained to a closed set, so the form renders a const-only select of these literals instead of a free-text path input. |
| ImportMapperRow | A single row in an import mapper. |
| ImportMapperRowType | Type of an import-mapper row, describing how source is interpreted. |
| ImportMapperType | Source type of an import mapper, deciding how the data to import is obtained. |
| IntentWithWallet | A policy intent enriched with its owning agent wallet, as returned by GET /v1/agent-wallets/intents. Used by the admin intent-validation page. |
| IntlString | - |
| 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. |
| InvestOfferType | String literal union of the invest offer types. |
| InvestTransaction | Transaction record for an investment fund. Represents a share movement: initial distribution, buy-back, or secondary market transfer. Either seller or buyer may be null depending on type. |
| InvestTransactionStatus | String literal union of the invest transaction statuses. |
| InvestTransactionType | String literal union of the invest transaction types. |
| Job | - |
| JobStatus | - |
| KeybanApiStatus | - |
| KeybanAssetTransfer | - |
| KeybanClientConfig | Configuration options for initializing the Keyban client. |
| KeybanNft | - |
| KeybanNftBalance | - |
| KeybanOrder | - |
| KeybanToken | - |
| KeybanTokenBalance | - |
| ListX402ResourcesQuery | - |
| 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 | - |
| MyInvestHolding | Current investor's holding in a fund (investor-facing, narrower than InvestHolding). |
| NativeCurrency | - |
| Network | Union across every supported blockchain runtime. |
| ObjectEnum | - |
| ObjectPath | - |
| 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 | - |
| PaginationArgs | Arguments for paginating a collection. |
| Path | - |
| PaymentRail | String literal union of the supported agent-wallet payment rails. |
| Permission | - |
| Permissions | - |
| Plan | - |
| PlanFeature | - |
| PlanPrice | - |
| PreferredCurrency | String literal union of the supported application display currencies. |
| 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. |
| SetDidWebDomainRequest | Body for PUT /v1/dpp/certification-key/did-web-config. Pass domain: null to disable self-hosted DID Web and fall back to did:key. |
| ShopifyPassportFields | - |
| ShopifyProductFields | - |
| ShopifyReport | - |
| 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. |
| SupportedEmailLocale | - |
| SupportedLocale | BCP 47 locale codes supported across the platform for user-facing content (e.g. DPP action labels, product descriptions). Source of truth shared between the backend, the admin UI and the DPP App. |
| 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). |
| UntpAddress | - |
| UntpBitstringStatusListEntry | - |
| UntpCharacteristics | - |
| UntpClaim | - |
| UntpClassification | - |
| UntpConformityTopic | - |
| UntpCountry | - |
| UntpCredentialIssuer | - |
| UntpDimension | - |
| UntpDpp | - |
| UntpIdGranularity | - |
| UntpImage | - |
| UntpLink | - |
| UntpMaterial | - |
| UntpMeasure | - |
| UntpPackage | - |
| UntpParty | - |
| UntpPartyRole | - |
| UntpPerformance | - |
| UntpPeriod | - |
| UntpProduct | - |
| UntpRenderTemplate2024 | - |
| UntpRole | - |
| UntpScore | - |
| UpdateAgentWallet | - |
| UpdateImportMapper | Body shape for updating an import mapper. |
| UpdateInvestFund | - |
| UpdateInvestIdentity | - |
| UpdateInvestLockup | - |
| UpdateInvestOffer | - |
| UpdateSigner | - |
| UpsertWalletPolicy | Payload of PUT /v1/agent-wallets/:id/policy. Tri-state fields: omitted = keep current value, null = clear, value = set. |
| VerifyDidWebConfigResponse | Discriminated result of POST /v1/dpp/certification-key/did-web-config/verify. Always returned with HTTP 200; status: 'failed' carries a reason matching a VerifyDidWebFailureReason value for actionable UI messaging. |
| WalletEventType | - |
| WalletInstallation | Wallet installation metrics (Google and Apple Wallet adoption). |
| WalletNotificationChannel | String literal union of the wallet notification channels. |
| WalletPolicy | Spending policy attached to an agent wallet: reference currency, per-transaction/daily/weekly/monthly caps (decimal strings in centi-units of the currency), human-approval threshold, and recipient/domain allow-lists. |
| X402Accept | - |
| X402Quality | - |
| X402Resource | - |