# Account Model API Reference The `Account` active model represents a financial account within the Quicksilver Engine. It provides a fluent interface for interacting with account data and performing various account-related operations directly on the object. ## Class: `Account` ```typescript class Account { constructor(data: AccountData, http: HttpClient) } ``` ## Constructor ### `constructor(data: AccountData, http: HttpClient)` Initializes a new `Account` instance. * `data`: [`AccountData`](/wiki/lantos1618/quicksilver-sdk/types-reference#accountdata-interface) - The raw account data retrieved from the API. * `http`: [`HttpClient`](/wiki/lantos1618/quicksilver-sdk/http-client-api-reference#httpclient-class) - An instance of the HTTP client for making API requests. ## Properties (Getters) ### `id: string` `string` // The unique identifier for the account. ### `name: string` `string` // The name of the account. ### `accountType: string` `string` // The type of account (e.g., 'Human', 'AgentMain', 'AgentDelegated'). ### `parentId: string | null` `string | null` // The ID of the parent account if this is a delegated account. ### `meta: Record` `Record` // Custom metadata associated with the account. ### `limits: { daily?: number | null; per_transaction?: number | null; total?: number | null }` `{ daily?: number | null; per_transaction?: number | null; total?: number | null }` // Transaction limits for the account (daily, per transaction, total). ### `createdAt: string` `string` // The ISO 8601 timestamp when the account was created. ### `updatedAt: string` `string` // The ISO 8601 timestamp when the account was last updated. ### `children: string[]` `string[]` // An array of IDs of direct child accounts. ## Methods ### `delegate(options: { name: string, limits: { daily: number } }): Promise` `Promise` // Delegates a new sub-agent account from this account. * `options`: `{ name: string, limits: { daily: number } }` - Options for the new sub-agent, including name and daily transaction limits. ### `transaction(details: Omit): Transaction` [`Transaction`](/wiki/lantos1618/quicksilver-sdk/transaction-model-api-reference#transaction-class) // Creates a new transaction originating from this account. Returns a fluent `Transaction` object. * `details`: `Omit` - The details for the new transaction, excluding auto-populated fields. ### `purchase(product: Product, options: { [key: string]: any }): Promise` `Promise` // Purchases a programmable product using this account as the payer. * `product`: [`Product`](/wiki/lantos1618/quicksilver-sdk/product-builder-api-reference#product-type) - The `Product` object to purchase. * `options`: `{ [key: string]: any }` - Additional options related to the purchase. ### `refresh(): Promise` `Promise` // Refreshes the account's data from the server, updating the current instance. ### `getChildren(): Promise` `Promise` // Retrieves all direct child accounts (delegated sub-agents) of this account. ### `updateLimits(limits: { daily?: number; per_transaction?: number; total?: number }): Promise` `Promise` // Updates the transaction limits for this account. * `limits`: `{ daily?: number; per_transaction?: number; total?: number }` - An object containing the limits to update. ### `getBalance(): Promise<{ amount: number; currency: string }>` `Promise<{ amount: number; currency: string }>` // Retrieves the current balance of the account. ### `isVerified(): boolean` `boolean` // Checks if the account has been verified. ### `isRootAccount(): boolean` `boolean` // Checks if the account is a root account (i.e., has no parent account). ### `submitKYC(kycData: { document_type: string; document_number: string; document_file?: File | Blob; }): Promise` `Promise` // Submits Know Your Customer (KYC) verification documents for the account. * `kycData`: `{ document_type: string; document_number: string; document_file?: File | Blob; }` - The KYC information and optional document file. ### `verify(verifiedBy: string): Promise` `Promise` // Marks the account as verified (typically an administrative action). * `verifiedBy`: `string` - The identifier of the user or system that performed the verification. ### `rejectVerification(reason: string): Promise` `Promise` // Rejects the account's verification status (typically an administrative action). * `reason`: `string` - The reason for rejecting the verification. ### `getVerificationStatus(): { status: 'unverified' | 'pending' | 'verified' | 'rejected'; verified_at?: string | null; kyc_data?: { document_type?: string; document_number?: string; verified_by?: string; } | null; }` `{ status: 'unverified' | 'pending' | 'verified' | 'rejected'; verified_at?: string | null; kyc_data?: { document_type?: string; document_number?: string; verified_by?: string; } | null; }` // Retrieves the current verification status and related details for the account. ### `canTransact(): boolean` `boolean` // Checks if the account is authorized to perform transactions (typically requires verification). ### `canDelegate(): boolean` `boolean` // Checks if the account is authorized to delegate sub-agents (typically requires verification).

Account Model API Reference

Page Viewers

Guest Views