| 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. |
| ApiErrorCode | - |
| Application | Application configuration and metadata. |
| ApplicationEventType | - |
| ApplicationFeature | String literal union of the supported application features. |
| ApplicationThemeMode | String literal union describing the theme mode options. |
| 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). |
| AuthUser | Authenticated user profile. |
| 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 |
| 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 | - |
| 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 | - |
| 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 | - |
| DppPassportEventType | - |
| DppPassportStatus | String literal union of the DPP passport lifecycle statuses. |
| DppUncpc | - |
| DynamicFieldDef | - |
| DynamicFieldsType | - |
| DynamicFieldType | - |
| Event | - |
| EventSubject | The domain entity that an audit/quota event targets. |
| EventType | The type of audit/quota event. |
| EvmNetwork | Allowed EVM network identifiers. |
| 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 | - |
| 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. |
| 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. |
| ImportMapperRow | A single row in an import mapper. |
| ImportMapperRowType | Type of an import-mapper row, describing how source is interpreted. |
| 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. |
| JobStatus | String literal union of the BullMQ job statuses. |
| 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 | - |
| 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 |
| 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 | Loyalty order returned by the indexer. |
| OrderItem | Individual item within a loyalty order. |
| Organization | - |
| OrganizationQuotas | - |
| 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. |
| 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 | - |
| ShopifyShop | - |
| Signer | - |
| 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. |
| StarknetNetwork | Allowed Starknet network identifiers. |
| Statements | - |
| StellarNetwork | Allowed Stellar network identifiers. |
| SupportedEmailLocale | BCP 47 language tags the backend i18n infrastructure ships email bundles for (nestjs-i18n + ICU MessageFormat, see ADR 0089). en-US is the source of truth; the others are translated bundles. |
| 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. |
| 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 | - |
| 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). |