TypeAlias.Account

type Account = {
  address: string;
  application: string;
  createdAt: string;
  dpp: {
     isActive: boolean;
     lastActivityAt?: Date | null;
     passportCount: number;
  };
  explorerUrl?: string;
  id: string;
  loyalty: {
     fixedRewardTier: string | null;
     optimisticBalance: string;
     rewardTier?:   | {
        application: string;
        bgImageUrl?: string | null;
        createdAt: string;
        currencyToPointRatio: number;
        id: string;
        name: string;
        requiredVisits: number;
        updatedAt: string;
      }
        | null;
     visits: number;
     zelty: {
        customerId?: number | null;
     };
  };
  network:   | "EthereumAnvil"
     | "BaseSepolia"
     | "StarknetDevnet"
     | "StarknetSepolia"
     | "StarknetMainnet"
     | "StellarQuickstart"
     | "StellarTestnet"
     | "StellarMainnet";
  updatedAt: string;
  user: {
     birthDate?: string | null;
     createdAt: string;
     email: string;
     emailVerified: boolean;
     id: string;
     image?: string | null;
     name: string;
     phoneNumber?: string | null;
     phoneNumberVerified?: boolean | null;
     preferredLocale?: "en-US" | "fr-FR" | "es-ES" | "it-IT" | null;
     updatedAt: string;
  };
};

Complete on-chain account information returned by the Keyban API.

Represents a customer account with blockchain address, loyalty program data, and user profile information. Each account is tied to a specific application and deployed on a blockchain network.

Type Declaration

Name	Type	Default value
address	string	-
application	string	-
createdAt	string	-
dpp	{ isActive: boolean; lastActivityAt?: Date	null; passportCount: number; }
dpp.isActive	boolean	-
dpp.lastActivityAt?	Date	null
dpp.passportCount	number	-
explorerUrl?	string	-
id	string	-
loyalty	{ fixedRewardTier: string	null; optimisticBalance: string; rewardTier?:
loyalty.fixedRewardTier	string	null
loyalty.optimisticBalance	string	-
loyalty.rewardTier?		{ application: string; bgImageUrl?: string
loyalty.visits	number	-
loyalty.zelty	{ customerId?: number	null; }
loyalty.zelty.customerId?	number	null
network		"EthereumAnvil"
updatedAt	string	-
user	{ birthDate?: string	null; createdAt: string; email: string; emailVerified: boolean; id: string; image?: string
user.birthDate?	string	null
user.createdAt	string	-
user.email	string	-
user.emailVerified	boolean	-
user.id	string	-
user.image?	string	null
user.name	string	-
user.phoneNumber?	string	null
user.phoneNumberVerified?	boolean	null
user.preferredLocale?	"en-US"	"fr-FR"
user.updatedAt	string	-

Example

const account: Account = {
  id: "550e8400-e29b-41d4-a716-446655440000",
  application: "app_123",
  network: Network.BaseSepolia,
  address: "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  user: { email: "user@example.com", name: "John Doe", ... },
  loyalty: { optimisticBalance: "1000", visits: 5, ... },
  createdAt: "2024-01-01T00:00:00Z",
  updatedAt: "2024-01-01T00:00:00Z"
};