@dossier-wiki/os-sdk 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,1556 @@
+export interface Paginated<T> {
+    data: T[];
+    pagination: PaginationMeta;
+}
+export interface AccountResponseDto {
+    id: string;
+    externalId?: string;
+    customerId: string;
+    productId?: string;
+    label: string;
+    accountCategory: 'DEPOSIT' | 'CREDIT' | 'LOAN' | 'WALLET' | 'SECURITIES' | 'OTHER';
+    accountType: 'CHECKING' | 'SAVINGS' | 'OPERATING' | 'TRUST' | 'INVESTMENT' | 'ESCROW' | 'CREDIT_CARD' | 'LINE_OF_CREDIT' | 'PERSONAL_LOAN' | 'MORTGAGE' | 'AUTO_LOAN' | 'BUSINESS_LOAN' | 'CRYPTO_WALLET' | 'MOBILE_WALLET' | 'PREPAID_CARD' | 'E_WALLET' | 'BROKERAGE' | 'FUND' | 'OTHER';
+    status: 'ACTIVE' | 'FROZEN' | 'CLOSED' | 'DORMANT';
+    currency?: string;
+    bankName?: string;
+    bankSwift?: string;
+    iban?: string;
+    accountNumber?: string;
+    customProperties?: Record<string, unknown>;
+    openedAt: string;
+    closedAt?: string;
+}
+export interface AddFaceImageDto {
+    /** URL to fetch and import. */
+    fileUrl: string;
+    note?: string;
+}
+export interface AddIdentificationDocumentDto {
+    type: string;
+    number: string;
+    /** ISO 3166-1 alpha-3 country code */
+    country: string;
+    expiryDate?: string;
+    dateOfIssue?: string;
+    notes?: string;
+    attachments?: AttachmentDto[];
+}
+export interface AddressDto {
+    line1: string;
+    line2?: string;
+    city: string;
+    state?: string;
+    postalCode: string;
+    /** ISO 3166-1 alpha-3 country code */
+    country: string;
+}
+export interface AlternateNameDto {
+    name: string;
+    type: 'TRADING' | 'DBA' | 'FORMER' | 'LOCAL' | 'TRANSLITERATED';
+}
+export interface AtmDetailsDto {
+    /** ATM terminal identifier. Pairs with operator for tier-2 ATM_TERMINAL key. */
+    terminalId?: string;
+    /** Operating institution name. */
+    operator?: string;
+    /** Free-form location label. */
+    locationDescription?: string;
+    /** ISO 3166-1 alpha-3 country code. */
+    country?: string;
+    /** Physical ATM address (when known). */
+    address?: PaymentLocationAddressDto;
+    /** Lat/lng of the ATM. */
+    coordinates?: PaymentLocationCoordinatesDto;
+    /** MCC 6011 typical for ATMs. */
+    merchantCategoryCode?: string;
+    /** Caller-supplied stable rail identifier (tier-1 key per spec ingestion/07 §5.1.2). Useful when terminalId+operator are unavailable. */
+    externalReference?: string;
+}
+export interface AttachmentDto {
+    /** URL to fetch and import into the tenant's storage. */
+    fileUrl: string;
+    /** Label like "Front", "Back", "Selfie holding ID" */
+    note?: string;
+}
+export interface BankAccountDetailsDto {
+    /** IBAN (tier-1 key when present). */
+    iban?: string;
+    /** SWIFT / BIC code of the holding bank. */
+    bankSwift?: string;
+    /** US ABA routing number. */
+    routingNumber?: string;
+    /** National sort code (UK / IE / similar). */
+    sortCode?: string;
+    /** Generic bank code (non-routing/non-SWIFT, e.g. local domestic clearing code). */
+    bankCode?: string;
+    /** Account number — paired with bankSwift / routingNumber / bankCode for tier-2 keys. */
+    accountNumber?: string;
+    /** Bank name (display only — not used as a resolution key). */
+    bankName?: string;
+    /** Caller-supplied stable rail identifier (tier-1 key per spec ingestion/07 §5.1.2). Universal escape hatch when standardised keys (IBAN/SWIFT/etc.) are unavailable. */
+    externalReference?: string;
+}
+export interface CashDetailsDto {
+    /** Free-form location description (branch name, city, etc.). */
+    locationDescription?: string;
+    /** Branch / depot / agent identifier. */
+    locationId?: string;
+    /** Physical address of the cash-handling location (when known). */
+    address?: PaymentLocationAddressDto;
+    /** Lat/lng of the cash-handling location. */
+    coordinates?: PaymentLocationCoordinatesDto;
+    /** Caller-supplied stable rail identifier (tier-1 key per spec ingestion/07 §5.1.2). For cash, this is the only resolution key — without it the rail is unresolvable. */
+    externalReference?: string;
+}
+export interface ChannelDto {
+    /** Channel type (WEB, MOBILE_APP, BRANCH, ATM, POS, API). */
+    type: string;
+    /** Session identifier. */
+    sessionId?: string;
+    /** Embedded session events (auth, copy-paste, form-fill, etc.). */
+    events?: ChannelEventDto[];
+}
+export interface ChannelEventDto {
+    /** Event type (e.g. session.auth, session.copy_paste). */
+    type: string;
+    /** When the event occurred. */
+    timestamp: string;
+    /** Event payload data. */
+    data?: Record<string, unknown>;
+}
+export interface CheckDetailsDto {
+    /** Drawee bank name as printed on the check face. Pairs with accountNumber for the tier-2 CHECK_ACCOUNT key. */
+    issuingBank?: string;
+    /** Drawee bank SWIFT/BIC. Pairs with accountNumber for tier-2 CHECK_SWIFT_ACCOUNT. */
+    issuingBankSwift?: string;
+    /** Drawee bank national clearing code (US ABA, IN IFSC, GB SortCode, …). Pairs with accountNumber for tier-2 CHECK_BANK_CODE_ACCOUNT. */
+    issuingBankCode?: string;
+    /** Drawer's account number on the check. */
+    accountNumber?: string;
+    /** Drawer's IBAN, when account is IBAN-eligible. Tier-1 CHECK_IBAN key. */
+    iban?: string;
+    /** Printed drawer name (typically matches counterparty.name). */
+    drawerName?: string;
+    /** Printed drawer address. */
+    drawerAddress?: PaymentLocationAddressDto;
+    /** Caller-supplied stable rail identifier (tier-1 key per spec ingestion/07 §5.1.2). */
+    externalReference?: string;
+}
+export interface ConfirmUploadDto {
+    /** File key returned from upload-url */
+    fileKey: string;
+    /** Original file name */
+    fileName: string;
+    /** Optional label or category */
+    label?: string;
+}
+export interface ContactDetailsDto {
+    namePrefix?: 'DOCT' | 'MIST' | 'MISS' | 'MADM' | 'MIIS';
+    name?: string;
+    /** E.164 format. */
+    phoneNumber?: string;
+    mobileNumber?: string;
+    faxNumber?: string;
+    emailAddress?: string;
+    emailPurpose?: string;
+    jobTitle?: string;
+    responsibility?: string;
+    department?: string;
+    preferredMethod?: 'LETT' | 'MAIL' | 'PHON' | 'FAXX' | 'CELL';
+}
+export interface CounterpartyInlineDto {
+    /** Caller-supplied stable identifier. When provided, used as the primary lookup key and stored as the counterparty externalId on create (spec ingestion/03 §3, §7). */
+    externalId?: string;
+    /** Counterparty name. */
+    name?: string;
+    /** ISO 3166-1 alpha-3 country code. */
+    country?: string;
+    /** Party type. */
+    type?: 'INDIVIDUAL' | 'ORGANIZATION' | 'UNKNOWN';
+    /** Country-scoped tax identifier (tier-1 key). Requires `country` to be set. Legacy single-value form — prefer `taxIdentifications[]` for new integrations. */
+    taxId?: string;
+    /** Payment instrument details. Use the discriminator `type` to select the subtype block; populate ONLY that block (e.g. type=CRYPTO_WALLET → cryptoWallet). Use type=OTHER + customFields for unmodelled rails. */
+    paymentDetails?: PaymentDetailsDto;
+    /** Tax identifications (ISO 20022 TaxParty). Source for TAX_ID tier-1 keys. Multiple entries allowed (different countries / types). */
+    taxIdentifications?: TaxIdentificationDto[];
+    /** Alternate names — DBA, trading names, former names, transliterations. Used for sanctions name-screening. */
+    alternateNames?: AlternateNameDto[];
+    /** Structured postal addresses (ISO 20022 PostalAddress27). Each entry carries a `type` discriminator (HOME / BIZZ / MLTO / DLVY / PBOX / ADDR). CBPR+ mandates structured addresses for cross-border wires from Nov 2025. */
+    postalAddresses?: PostalAddressDto[];
+    /** Contact details (ISO 20022 ContactDetails2). */
+    contactDetails?: ContactDetailsDto;
+    /** Individual-specific attributes (ISO 20022 PrvtId). Allowed only when `type=INDIVIDUAL`. Mutually exclusive with `entityDetails`. */
+    individualDetails?: IndividualDetailsDto;
+    /** Entity-specific attributes (ISO 20022 OrgId). Allowed only when `type=ORGANIZATION`. Mutually exclusive with `individualDetails`. Carries `lei` — source for LEI tier-1 keys. */
+    entityDetails?: EntityDetailsDto;
+}
+export interface CounterpartyInternalDto {
+    /** Customer identifier of the other party. Internal UUID or `ext:`-prefixed external ID. */
+    customerId: string;
+    /** Account identifier of the other party. Internal UUID or `ext:`-prefixed external ID. */
+    accountId: string;
+}
+export interface CounterpartyPayloadDto {
+    /** Counterparty reference. Internal UUID or `ext:`-prefixed external ID. Bypasses key-based resolution. */
+    counterpartyId?: string;
+    /** Internal counterparty — the other party is also a customer. Triggers dual-perspective evaluation. */
+    internal?: CounterpartyInternalDto;
+    /** Inline counterparty details for create-on-miss resolution. */
+    inline?: CounterpartyInlineDto;
+}
+export interface CounterpartyResponseDto {
+    id: string;
+    externalId?: string;
+    name: string;
+    description?: string;
+    identity: 'INDIVIDUAL' | 'ENTITY' | 'UNKNOWN';
+    classification: 'BANK_ACCOUNT' | 'WALLET' | 'MERCHANT' | 'FINANCIAL_INSTITUTION' | 'PAYMENT_NETWORK' | 'UNKNOWN';
+    country?: string;
+    riskLevel: 'HIGH' | 'MEDIUM' | 'LOW' | 'UNRATED';
+    source: 'MANUAL' | 'SYSTEM';
+    linkedCustomerIds: string[];
+    /** ID of the transaction that first created this counterparty */
+    originatingTransactionId?: string;
+    bankAccount?: BankAccountDetailsDto;
+    wallet?: CryptoWalletDetailsDto;
+    merchant?: MerchantDetailsDto;
+    institution?: InstitutionDetailsDto;
+    firstTransactionAt?: string;
+    lastTransactionAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateAccountDto {
+    /** Your external identifier */
+    externalId?: string;
+    /** Product ID this account is based on */
+    productId?: string;
+    label: string;
+    accountCategory: 'DEPOSIT' | 'CREDIT' | 'LOAN' | 'WALLET' | 'SECURITIES' | 'OTHER';
+    accountType: 'CHECKING' | 'SAVINGS' | 'OPERATING' | 'TRUST' | 'INVESTMENT' | 'ESCROW' | 'CREDIT_CARD' | 'LINE_OF_CREDIT' | 'PERSONAL_LOAN' | 'MORTGAGE' | 'AUTO_LOAN' | 'BUSINESS_LOAN' | 'CRYPTO_WALLET' | 'MOBILE_WALLET' | 'PREPAID_CARD' | 'E_WALLET' | 'BROKERAGE' | 'FUND' | 'OTHER';
+    /** Currency code (ISO 4217) */
+    currency?: string;
+    bankName?: string;
+    bankSwift?: string;
+    iban?: string;
+    accountNumber?: string;
+    /** Arbitrary key-value properties */
+    customProperties?: Record<string, unknown>;
+    /** Override account opening timestamp (ISO 8601). Used by data-loading tools to backfill historical accounts. */
+    openedAt?: string;
+}
+export interface CreateApiKeyDto {
+    /** Human-readable label for this API key */
+    label: string;
+    /** Access scope */
+    scope: 'full_access' | 'evaluate_only';
+    /** Expiration in seconds (default: 1 year) */
+    expiresInSeconds?: number;
+    /** Organization ID to scope this key to (defaults to active org) */
+    organizationId?: string;
+}
+export interface CreateConstantDto {
+    /** Constant name (e.g. $global.highRiskCountries). */
+    name: string;
+    /** Scope (derived from name if omitted). */
+    scope?: 'global' | 'product' | 'customer' | 'account' | 'counterparty' | 'instrument' | 'device';
+    /** Constant type. Determines the required shape of `value`. */
+    type: 'scalar' | 'monetary' | 'set' | 'range' | 'text' | 'number' | 'boolean' | 'date' | 'currency';
+    /** Payload shape depends on the constant's `type`. Pick the matching variant below. Validated at write time. */
+    value: {
+        /** e.g. `"1000000@FIAT:USD"` = $10,000.00. Precision implied by currency: USD=2, JPY=0, BTC=8, ETH=9, USDT/USDC=6. */
+        value: string;
+    } | {
+        values: string[];
+    } | {
+        min: unknown;
+        max: unknown;
+    } | {
+        value: unknown;
+    };
+    /** Human-readable description. */
+    description?: string;
+    /** Sync key for config-as-code management. */
+    syncKey?: string;
+}
+export interface CreateCounterpartyDto {
+    externalId?: string;
+    name: string;
+    description?: string;
+    identity: 'INDIVIDUAL' | 'ENTITY' | 'UNKNOWN';
+    classification: 'BANK_ACCOUNT' | 'WALLET' | 'MERCHANT' | 'FINANCIAL_INSTITUTION' | 'PAYMENT_NETWORK' | 'UNKNOWN';
+    /** ISO 3166-1 alpha-3 country code */
+    country?: string;
+    bankAccount?: BankAccountDetailsDto;
+    wallet?: CryptoWalletDetailsDto;
+    merchant?: MerchantDetailsDto;
+    institution?: InstitutionDetailsDto;
+}
+/** OpenAPI schema is empty; treated as an opaque key/value bag — narrow on the caller side. */
+export type CreateCurrencyInput = Record<string, unknown>;
+export interface CreateEntityDto {
+    /** Your external identifier for this entity. Must be unique within the organization. */
+    externalId: string;
+    legalName: string;
+    tradingNames?: string[];
+    registrationNumber?: string;
+    /** ISO 3166-1 alpha-3 country code */
+    countryOfIncorporation?: string;
+    dateOfIncorporation?: string;
+    entityType?: string;
+    /** Parent entity ID for subsidiaries */
+    parentEntityId?: string;
+    email?: string;
+    phone?: string;
+    addresses?: AddressDto[];
+    /** Override creation timestamp (ISO 8601). Used by data-loading tools to backfill historical entities. */
+    createdAt?: string;
+}
+export interface CreateEventDefinitionDto {
+    /** Unique event name (used as key). */
+    name: string;
+    /** Human-readable display name. */
+    displayName?: string;
+    /** Event description. */
+    description?: string;
+    /** Event category. */
+    category?: string;
+    /** Event properties schema. */
+    properties?: Record<string, unknown>[];
+    /** Sync key for config-as-code management. */
+    syncKey?: string;
+}
+export interface CreateIndividualDto {
+    /** Your external identifier for this customer. Must be unique within the organization. */
+    externalId: string;
+    fullName: string;
+    preferredName?: string;
+    dateOfBirth?: string;
+    /** ISO 3166-1 alpha-3 country codes */
+    nationality?: string[];
+    /** ISO 3166-1 alpha-3 country codes */
+    countryOfResidence?: string[];
+    email?: string;
+    phone?: string;
+    identificationDocuments?: IdentificationDocumentDto[];
+    addresses?: AddressDto[];
+    /** Override creation timestamp (ISO 8601). Used by data-loading tools to backfill historical customers. */
+    createdAt?: string;
+}
+export interface CreateNoteDto {
+    /** Note text content */
+    text: string;
+}
+export interface CreateProductDto {
+    /** Unique external ID (e.g. COMBANK-SAV-REG). */
+    externalId: string;
+    /** Product name. */
+    name: string;
+    /** Product description. */
+    description?: string;
+    /** Account category. */
+    category: string;
+    /** Base account type. */
+    baseType: string;
+    /** Default currency in TYPE:CODE format. */
+    defaultCurrency: string;
+    /** ISO 3166-1 alpha-3 country code. */
+    country?: string;
+    /** Supported transaction method IDs. */
+    supportedMethodIds: string[];
+    /** Arbitrary product metadata. */
+    metadata?: Record<string, unknown>;
+    /** Sync key for config-as-code management. */
+    syncKey?: string;
+}
+export interface CreateRiskAssessmentDto {
+    answers: RiskAssessmentAnswerDto[];
+    resultingRiskLevel: 'HIGH' | 'MEDIUM' | 'LOW' | 'UNRATED';
+    computedRiskLevel?: 'HIGH' | 'MEDIUM' | 'LOW' | 'UNRATED';
+    ratingOverridden?: boolean;
+    overrideJustification?: string;
+    narrative?: string;
+    riskTags?: string[];
+}
+export interface CreateRiskQuestionnaireDto {
+    answers: RiskQuestionnaireAnswerDto[];
+    /** Optional narrative summary */
+    narrative?: string;
+}
+export interface CreateRuleDto {
+    /** Rule name. */
+    name: string;
+    /** Rule description. */
+    description?: string;
+    /** Rule subject. */
+    subject: string;
+    /** Rule trigger. */
+    trigger?: string;
+    /** Rule severity. */
+    severity: 'HIGH' | 'MEDIUM' | 'LOW';
+    /** Tags for categorisation. */
+    tags?: string[];
+    /** Condition tree (AND/OR logic with leaf conditions). */
+    conditionTree?: Record<string, unknown>;
+    /** Actions to execute when the rule triggers. */
+    actions?: string[];
+    /** Window period for aggregate conditions. */
+    windowPeriod?: string;
+    /** Initial status for the rule. */
+    initialStatus?: 'DRAFT' | 'ACTIVE' | 'DISABLED';
+    /** Sync key for config-as-code management. */
+    syncKey?: string;
+}
+export interface CreateStakeholderDto {
+    name: string;
+    role: 'SHAREHOLDER' | 'UBO' | 'DIRECTOR';
+    /** Ownership percentage (0–100) */
+    ownershipPercentage?: number;
+    /** ISO 3166-1 alpha-3 country code */
+    nationality?: string;
+    dateOfBirth?: string;
+    /** Link to an existing Individual customer */
+    individualId?: string;
+    /** Link to an existing Entity customer */
+    entityId?: string;
+}
+export interface CreateWebhookDto {
+    /** Webhook destination name. */
+    name: string;
+    /** Destination URL (must be HTTPS). */
+    url: string;
+    /** Human-readable description. */
+    description?: string;
+    /** Event types to subscribe to. */
+    events: string[];
+    /** Sync key for config-as-code management. */
+    syncKey?: string;
+}
+export interface CryptoWalletDetailsDto {
+    /** On-chain wallet address. Tier-1 key for resolution when paired with blockchain — but optional so the same DTO can also represent a partially-known wallet record (e.g. admin CRUD). */
+    walletAddress?: string;
+    /** Blockchain identifier (e.g. ETH, BTC, SOLANA, POLYGON). Required for unambiguous resolution; resolver falls back to chain="UNKNOWN" when absent. */
+    blockchain?: string;
+    /** Wallet provider / custodian (Coinbase, Binance, MetaMask, …). */
+    walletProvider?: string;
+    /** Wallet type (CUSTODIAL, SELF_CUSTODY, EXCHANGE). */
+    walletType?: string;
+    /** Caller-supplied stable rail identifier (tier-1 key per spec ingestion/07 §5.1.2). */
+    externalReference?: string;
+}
+export interface DeviceBrowserDetailsDto {
+    /** Browser name (Chrome, Safari, Firefox, …). */
+    browserName?: string;
+    /** Browser major version (e.g. "120"). */
+    browserMajorVersion?: string;
+    /** Browser full version (e.g. "120.0.6099.71"). */
+    browserFullVersion?: string;
+    /** Browser version (legacy alias for browserFullVersion). */
+    browserVersion?: string;
+    /** Operating system identifier (Windows, macOS, iOS, Android, Linux). */
+    os?: string;
+    /** OS version string. */
+    osVersion?: string;
+    /** Raw User-Agent header. */
+    userAgent?: string;
+    /** Caller-supplied device type (DESKTOP, MOBILE, TABLET, BOT). Server may override based on user-agent. */
+    device?: string;
+}
+export interface DigitalWalletDetailsDto {
+    /** Provider (PayPal, Venmo, ApplePay, GooglePay, …). Tier-1 key when paired with walletId. */
+    provider?: string;
+    /** Provider-scoped wallet identifier. */
+    walletId?: string;
+    /** Mobile number (E.164). Tier-2 key when paired with provider. */
+    mobileNumber?: string;
+    /** Mobile network operator (relevant for mobile-money rails). */
+    networkOperator?: string;
+    /** Caller-supplied stable rail identifier (tier-1 key per spec ingestion/07 §5.1.2). */
+    externalReference?: string;
+}
+export interface EntityDetailsDto {
+    /** Legal Entity Identifier (ISO 17442). Source for LEI tier-1 keys. */
+    lei?: string;
+    /** PLC, LLC, GmbH, KK, … */
+    legalForm?: string;
+    /** YYYY-MM-DD */
+    dateOfIncorporation?: string;
+    /** ISO 3166-1 alpha-3 country code. Distinct from operating country. */
+    countryOfIncorporation?: string;
+    /** Registered office address (single record — distinct from operating addresses). */
+    registeredAddress?: PostalAddressDto;
+    industryCodes?: IndustryCodeDto[];
+    /** Source for NATIONAL_ID tier-1 keys. Entity schemes: COID, DUNS, BANK, CHID, CUST. */
+    nationalIdentifications?: NationalIdentificationDto[];
+    /** Legal lifecycle of the entity (DISSOLVED, MERGED, …). Distinct from the row-level lifecycleStatus which tracks operational state in Dossiers. Set by operator or external company-registry feed. */
+    operationalStatus?: 'ACTIVE' | 'DISSOLVED' | 'IN_LIQUIDATION' | 'MERGED' | 'UNKNOWN';
+    /** YYYY-MM-DD */
+    operationalStatusAsOf?: string;
+    websites?: string[];
+}
+export interface EntityResponseDto {
+    id: string;
+    externalId?: string;
+    type: string;
+    legalName: string;
+    tradingNames?: string[];
+    registrationNumber?: string;
+    countryOfIncorporation?: string;
+    dateOfIncorporation?: string;
+    entityType?: string;
+    parentEntityId?: string;
+    email?: string;
+    phone?: string;
+    riskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+    kycTier?: 'NO_KYC' | 'SDD' | 'CDD' | 'EDD' | 'ONGOING';
+    alertCount: number;
+    addresses: AddressDto[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ExchangeRateEntryDto {
+    /** Source currency in TYPE:CODE format (e.g. FIAT:EUR, CRYPTO:BTC) */
+    fromCurrency: string;
+    /** Target currency in TYPE:CODE format — must be the tenant base currency */
+    toCurrency: string;
+    /** Exchange rate as a string to preserve precision (fromCurrency -> toCurrency) */
+    rate: string;
+    /** When this rate became effective (ISO 8601) */
+    effectiveAt: string;
+    /** Provider or method that supplied this rate */
+    source: string;
+}
+export interface FeeDto {
+    /** Fee type (e.g. WIRE_FEE, CORRESPONDENT_FEE, ATM_FEE). */
+    type: string;
+    /** Fee amount in minor currency units. */
+    amount: number;
+    /** Fee currency in TYPE:CODE format. */
+    currency: string;
+    /** Who charged the fee (INSTITUTION, INTERMEDIARY, NETWORK). */
+    chargedBy: string;
+    /** Human-readable fee description. */
+    description?: string;
+}
+export interface IPSessionDto {
+    ipAddress?: string;
+    isProxy?: boolean;
+    isTor?: boolean;
+    incognito?: boolean;
+    /** ISO 8601 timestamp the IP was observed. */
+    seenAt?: string;
+    city?: string;
+    country?: string;
+    isVPN?: boolean;
+    vpnProvider?: string;
+}
+export interface IdentificationDocumentDto {
+    /** Document type */
+    type: string;
+    number: string;
+    /** ISO 3166-1 alpha-3 country code */
+    issuingCountry: string;
+    expiryDate?: string;
+}
+export type IdentificationDocumentStatus = 'PENDING' | 'APPROVED' | 'REJECTED';
+/** Computed status — also reflects expiry and archive state. */
+export type IdentificationDocumentEffectiveStatus = IdentificationDocumentStatus | 'EXPIRED' | 'INACTIVE';
+export type IdentificationDocumentArchiveReason = 'LOST' | 'STOLEN' | 'REPLACED' | 'NAME_CHANGE' | 'OTHER';
+export interface UserRef {
+    userId: string;
+    name: string;
+    email?: string;
+    role?: string;
+    avatar?: string;
+    /** Discriminates human users from service principals. */
+    type?: 'USER' | 'SERVICE';
+    apiKeySanitized?: string;
+}
+export interface RichAddressDto {
+    /** Label for the address (e.g. Primary, Permanent, Mailing). */
+    tag?: string;
+    line1?: string;
+    line2?: string;
+    city?: string;
+    state?: string;
+    postalCode?: string;
+    /** ISO-3166 alpha-3 country code. */
+    country?: string;
+    verified?: boolean;
+    verifiedAt?: string;
+    /** IDs of source documents that contributed this address. */
+    documentIds?: string[];
+}
+export interface RichAddressInputDto {
+    /** Label for the address (e.g. Primary, Permanent, Mailing). */
+    tag: string;
+    line1: string;
+    line2?: string;
+    city: string;
+    state?: string;
+    postalCode?: string;
+    /** ISO-3166 alpha-3 country code. */
+    country: string;
+}
+export interface IdDocFileAttachment {
+    /** ID of a previously uploaded CustomerFile. */
+    fileId: string;
+    /** Optional caption (e.g. 'Front side', 'Back side'). */
+    note?: string;
+    /** Resolved file metadata (name, mime type, size, downloadUrl). */
+    file?: CustomerFile;
+}
+/**
+ * Provide exactly one of `fileId` or `fileUrl`:
+ *  - `fileId` — UUID of a CustomerFile uploaded via `/v1/customers/{customerId}/files/upload-url` + `/confirm`.
+ *    Platform-file ids (from `/v1/platform/v1/files/upload-url`) are scoped to comment attachments and will be rejected here.
+ *  - `fileUrl` — URL the server should fetch and persist as a CustomerFile in the target customer. No client-side upload roundtrip.
+ */
+export interface IdDocFileAttachmentInput {
+    fileId?: string;
+    fileUrl?: string;
+    /** Optional caption (e.g. 'Front side', 'Back side'). */
+    note?: string;
+}
+export interface IdentificationDocument {
+    id: string;
+    customerId: string;
+    /** e.g. PASSPORT, DRIVERS_LICENSE, NATIONAL_ID */
+    type: string;
+    number: string;
+    /** ISO-3166 alpha-3 country code of the issuing authority. */
+    country: string;
+    dateOfIssue?: string;
+    expiryDate?: string;
+    /** Full name as printed on the document, transliterated into English. */
+    fullNameEn?: string;
+    /** Additional name variants in other scripts/languages. */
+    transliterationNames?: string[];
+    /** Addresses printed on the document. */
+    addresses?: RichAddressDto[];
+    dateOfBirth?: string;
+    /** Sex/gender as printed on the document (free-form). */
+    sex?: string;
+    /** Free-form key/value metadata captured from the document. */
+    other?: Record<string, unknown>;
+    status: IdentificationDocumentStatus;
+    effectiveStatus: IdentificationDocumentEffectiveStatus;
+    rejectionNarrative?: string;
+    tags: string[];
+    attachments: IdDocFileAttachment[];
+    /** @deprecated Use attachments[].fileId instead. */
+    fileIds?: string[];
+    notes?: string;
+    archivedAt?: string;
+    archivedReason?: IdentificationDocumentArchiveReason;
+    archivedNotes?: string;
+    archivedBy?: UserRef;
+    createdBy: UserRef;
+    updatedBy?: UserRef;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateIdentificationDocumentInput {
+    /** e.g. PASSPORT, DRIVERS_LICENSE, NATIONAL_ID */
+    type: string;
+    number: string;
+    /** ISO-3166 alpha-3 country code of the issuing authority. */
+    country: string;
+    dateOfIssue?: string;
+    expiryDate?: string;
+    /** Full name as printed on the document, transliterated into English. */
+    fullNameEn?: string;
+    /** Additional name variants in other scripts/languages. */
+    transliterationNames?: string[];
+    /** Addresses printed on the document. */
+    addresses?: RichAddressInputDto[];
+    dateOfBirth?: string;
+    /** Sex/gender as printed on the document (free-form). */
+    sex?: string;
+    /** Free-form key/value metadata. */
+    other?: Record<string, unknown>;
+    tags?: string[];
+    attachments?: IdDocFileAttachmentInput[];
+    notes?: string;
+}
+export interface UpdateIdentificationDocumentInput {
+    type?: string;
+    number?: string;
+    country?: string;
+    dateOfIssue?: string;
+    expiryDate?: string;
+    fullNameEn?: string;
+    transliterationNames?: string[];
+    addresses?: RichAddressInputDto[];
+    dateOfBirth?: string;
+    sex?: string;
+    other?: Record<string, unknown>;
+    tags?: string[];
+    attachments?: IdDocFileAttachmentInput[];
+    notes?: string;
+}
+export interface ArchiveIdentificationDocumentInput {
+    reason: IdentificationDocumentArchiveReason;
+    /** Additional context. */
+    notes?: string;
+}
+export interface TransitionIdentificationDocumentStatusInput {
+    status: IdentificationDocumentStatus;
+    /** Required when status = REJECTED. */
+    rejectionNarrative?: string;
+    /** Optional rejection classification tags. */
+    rejectionTags?: string[];
+}
+export interface ListIdentificationDocumentsQuery {
+    /** Include archived (soft-deleted) documents. */
+    includeArchived?: boolean;
+    status?: IdentificationDocumentStatus;
+}
+export interface DeleteIdentificationDocumentResponse {
+    deletedId: string;
+}
+/** Resource types that can carry platform comments. */
+export type CommentResourceType = 'CUSTOMER' | 'ACCOUNT' | 'TRANSACTION' | 'TASK' | 'ALERT' | 'COMMENT' | 'COUNTERPARTY' | 'DEVICE' | 'RULE' | 'PRODUCT' | 'INSTRUMENT' | 'IDENTIFICATION_DOCUMENT';
+export interface PlatformCommentAttachmentInput {
+    /** fileId returned by /platform/v1/files/upload-url */
+    fileId: string;
+    name?: string;
+    type?: string;
+    size?: number;
+}
+export interface PlatformCommentAttachment extends PlatformCommentAttachmentInput {
+    /** Short-lived presigned download URL (when resolved by the server). */
+    downloadUrl?: string;
+}
+export interface PlatformCreateCommentDto {
+    resourceType: CommentResourceType;
+    resourceId: string;
+    /** Markdown body (GFM tables supported). */
+    body: string;
+    attachments?: PlatformCommentAttachmentInput[];
+    /** Optional idempotency key. Re-POSTing with the same value returns the existing comment instead of creating a duplicate. Unique per principal. */
+    externalRequestId?: string;
+}
+export interface PlatformUpdateCommentDto {
+    /** Markdown body (GFM tables supported). */
+    body: string;
+}
+export interface ListPlatformCommentsQuery {
+    resourceType: CommentResourceType;
+    resourceId: string;
+}
+/** Comment response shape — the OpenAPI spec does not document a full schema, so callers should narrow as needed. */
+export interface PlatformComment {
+    id: string;
+    resourceType: CommentResourceType;
+    resourceId: string;
+    body: string;
+    attachments?: PlatformCommentAttachment[];
+    author: UserRef;
+    createdAt: string;
+    updatedAt: string;
+    editedAt?: string;
+    [key: string]: unknown;
+}
+export interface PlatformRequestUploadUrlDto {
+    fileName: string;
+    contentType: string;
+    fileSizeBytes?: number;
+}
+export interface PlatformConfirmUploadDto {
+    fileId: string;
+}
+export interface CustomerFile {
+    id: string;
+    /** Original file name. */
+    name: string;
+    /** MIME type. */
+    type: string;
+    /** File size in bytes. */
+    size: number;
+    uploadedAt: string;
+    uploadedBy: UserRef;
+    category?: string;
+    /** Short-lived presigned download URL. */
+    downloadUrl?: string;
+    description?: string;
+}
+export interface IndividualDetailsDto {
+    /** YYYY-MM-DD. ISO 20022 DateAndPlaceOfBirth.BirthDate. */
+    dateOfBirth?: string;
+    placeOfBirth?: PlaceOfBirthDto;
+    gender?: 'M' | 'F' | 'X' | 'UNKNOWN';
+    /** ISO 3166-1 alpha-3 country code. */
+    nationality?: string;
+    /** ISO 3166-1 alpha-3 country code. Distinct from operating country. */
+    countryOfResidence?: string;
+    occupation?: string;
+    employerName?: string;
+    /** Source for NATIONAL_ID tier-1 keys. Individual schemes: NIDN, CCPT, DRLC, SOSE, ARNU, CUST. */
+    nationalIdentifications?: NationalIdentificationDto[];
+}
+export interface IndividualResponseDto {
+    id: string;
+    externalId?: string;
+    type: string;
+    fullName: string;
+    preferredName?: string;
+    dateOfBirth?: string;
+    nationality?: string[];
+    countryOfResidence?: string[];
+    email?: string;
+    phone?: string;
+    riskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+    kycTier?: 'NO_KYC' | 'SDD' | 'CDD' | 'EDD' | 'ONGOING';
+    alertCount: number;
+    identificationDocuments: IdentificationDocumentDto[];
+    addresses: AddressDto[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface IndustryCodeDto {
+    /** Classification scheme. */
+    scheme: 'NAICS' | 'SIC' | 'NACE' | 'ISIC' | 'MCC';
+    code: string;
+}
+export interface IngestDevicePayloadDto {
+    /** Provider-supplied device fingerprint (e.g. FingerprintJS visitorId). Used as the resolution key — when absent the resolver no-ops (transaction is recorded with deviceId=null). */
+    fingerprint?: string;
+    /** Browser / OS details. */
+    browserDetails?: DeviceBrowserDetailsDto;
+    /** IP sessions observed for this device. */
+    ipSessions?: IPSessionDto[];
+    /** Bot probability score (0-1). Persisted only on first sight; server-computed values take precedence later. */
+    botProbability?: number;
+    /** Detection confidence score (0-1). */
+    confidence?: number;
+}
+export interface IngestEventDto {
+    /** Event type (core or custom). Core types: customer.failed_login, customer.profile_updated. Custom types match event definitions. */
+    type: string;
+    /** When the event occurred. */
+    timestamp: string;
+    /** Customer ID this event is associated with. */
+    customerId: string;
+    /** Account ID if the event is account-scoped. */
+    accountId?: string;
+    /** Device identifier for device-context rules. */
+    deviceId?: string;
+    /** Session identifier for session-context rules. */
+    sessionId?: string;
+    /** Event-specific payload data. Schema depends on event type. */
+    data?: Record<string, unknown>;
+}
+export interface IngestTransactionDto {
+    /** Your unique identifier for this transaction. Used for idempotency. */
+    transactionId: string;
+    /** When the transaction occurred in your system. */
+    timestamp: string;
+    /** The transaction payload. */
+    transaction: TransactionBodyDto;
+    /** Payment instrument used for this transaction. */
+    instrument?: InstrumentPayloadDto;
+    /** Intermediary banks/institutions in the payment chain. */
+    intermediaries?: IntermediaryDto[];
+    /** Device / fingerprint data used for device-based rules and device-trust resolution. */
+    device?: IngestDevicePayloadDto;
+    /** Set to true for async processing. Returns 202 Accepted immediately; results delivered via webhook. */
+    async?: boolean;
+}
+export interface InitializeSetupDto {
+    /** Admin user full name */
+    name: string;
+    /** Admin email address */
+    email: string;
+    /** Admin password (min 8 characters) */
+    password: string;
+    /** Organization name */
+    organizationName: string;
+    /** Organization slug (URL-friendly identifier) */
+    organizationSlug: string;
+    /** Enable Transaction Intelligence product */
+    transactionIntelligence?: boolean;
+    /** Enable KYC vendor integration (within Customer Monitoring) */
+    kyc?: boolean;
+}
+export interface InstitutionDetailsDto {
+    swift?: string;
+    lei?: string;
+    regulatoryStatus?: string;
+}
+export interface InstrumentPayloadDto {
+    /** Instrument identifier. */
+    id: string;
+    /** Human-readable name persisted as instruments.displayName (e.g. "Personal Visa", "Travel Card"). */
+    name?: string;
+    /** Instrument type (CARD, VIRTUAL_CARD, WALLET_TOKEN, etc.). */
+    type?: string;
+    /** Instrument status (ACTIVE, BLOCKED, EXPIRED, etc.). */
+    status?: string;
+    /** Token or masked identifier. */
+    token?: string;
+}
+export interface IntermediaryDto {
+    /** Role of the intermediary (e.g. CORRESPONDENT, CLEARING_BANK). */
+    role: string;
+    /** Position in the intermediary chain (0-indexed). */
+    position: number;
+    /** Intermediary name. */
+    name?: string;
+    /** ISO 3166-1 alpha-3 country code. */
+    country?: string;
+    /** Entity type. */
+    type?: string;
+    /** Payment instrument details. */
+    paymentDetails?: Record<string, unknown>;
+}
+export interface LinkCounterpartyDto {
+    /** Customer ID to link */
+    customerId: string;
+}
+export interface MerchantDetailsDto {
+    /** Acquirer/processor-scoped merchant identifier. Tier-2 key when paired with acquirerBin or merchantCountry. */
+    merchantId?: string;
+    /** Acquirer BIN. Pairs with merchantId for tier-2 MERCHANT_ID key. */
+    acquirerBin?: string;
+    /** Acquirer name (display). */
+    acquirerName?: string;
+    /** Card network used at the merchant terminal. */
+    cardNetwork?: string;
+    /** Merchant category code (ISO 18245). */
+    merchantCategoryCode?: string;
+    /** Merchant display name. */
+    merchantName?: string;
+    /** ISO 3166-1 alpha-3 country code where the merchant operates. Pairs with merchantId for tier-2 fallback when acquirerBin is absent. */
+    merchantCountry?: string;
+    /** POS terminal identifier. */
+    terminalId?: string;
+    /** Physical merchant address (when known). */
+    address?: PaymentLocationAddressDto;
+    /** Lat/lng of the merchant terminal or storefront. */
+    coordinates?: PaymentLocationCoordinatesDto;
+    /** Caller-supplied stable rail identifier (tier-1 key per spec ingestion/07 §5.1.2). */
+    externalReference?: string;
+}
+export interface MetadataBooleanWrapperDto {
+    type: 'boolean';
+    value: boolean;
+}
+export interface MetadataCurrencyWrapperDto {
+    type: 'currency';
+    /** TYPE:CODE identifier validated against the tenant currency registry. */
+    value: string;
+}
+export interface MetadataDateWrapperDto {
+    type: 'date';
+    /** ISO 8601 calendar date (YYYY-MM-DD) or full datetime with timezone. */
+    value: string;
+}
+export interface MetadataMonetaryWrapperDto {
+    type: 'monetary';
+    /** Denominated literal `<amount>@<TYPE:CODE>` (major units). Normalised to minor units at ingest. */
+    value: string;
+}
+export interface MetadataNumberWrapperDto {
+    type: 'number';
+    value: number;
+}
+export interface MetadataSetWrapperDto {
+    type: 'set';
+    value: string[];
+}
+export interface MetadataTextWrapperDto {
+    type: 'text';
+    value: string;
+}
+export interface NationalIdentificationDto {
+    /** Scheme code. Individual schemes: NIDN, CCPT, DRLC, SOSE, ARNU, CUST. Entity schemes: COID, DUNS, BANK, CHID, CUST. Proprietary schemes also accepted. */
+    scheme: string;
+    value: string;
+    /** ISO 3166-1 alpha-3 country code (namespace for the identifier). */
+    country: string;
+    issuer?: string;
+}
+export interface OtherPaymentDetailsDto {
+    /** Caller-defined subtype label, e.g. "barter", "store_credit", "loyalty_points". */
+    subtype: string;
+    /** Free-form description of the payment rail. */
+    description?: string;
+    /** Caller-defined fields. Stored verbatim on the snapshot; not used for resolution. */
+    customFields?: Record<string, unknown>;
+    /** Caller-supplied stable rail identifier (tier-1 key per spec ingestion/07 §5.1.2). Only resolution key for this rail. */
+    externalReference?: string;
+}
+export interface PaginationMeta {
+    /** Cursor to fetch the next page, null if no more results */
+    nextCursor: Record<string, unknown> | null;
+    /** Total number of items matching the query */
+    totalCount: number;
+}
+export interface PatchTransactionStatusDto {
+    /** Internal transaction UUID returned from `POST /transactions` (the `id` field on the response). Provide either this OR `transactionId`. */
+    id?: string;
+    /** Caller-supplied transaction id (the same value sent as `transactionId` on POST — `reference` column). Provide either this OR `id`. */
+    transactionId?: string;
+    /** New status. Must be a valid transition from the current status (see ALLOWED_STATUS_TRANSITIONS). */
+    status: 'PENDING' | 'PROCESSING' | 'COMPLETE' | 'REJECTED' | 'REVERSED' | 'BLOCKED';
+    /** When the status change occurred in your system. Stored on the transaction row as `status_changed_at`. Does not modify `executed_at` (immutable). */
+    statusChangedAt: string;
+    /** Human-readable reason for terminal transitions (REJECTED, REVERSED, BLOCKED). Stored in statusHistory for audit. */
+    terminalReason?: string;
+}
+export interface PaymentDetailsDto {
+    /** Discriminator selecting which payment subtype block to populate. NOTE: card-on-file (the instrument the principal customer paid with) is modelled separately on the transaction `instrument` field — counterparty payment details describe how the OTHER party receives money. */
+    type: 'BANK_ACCOUNT' | 'CRYPTO_WALLET' | 'DIGITAL_WALLET' | 'MERCHANT' | 'PROCESSOR' | 'CASH' | 'CHECK' | 'ATM' | 'OTHER';
+    bankAccount?: BankAccountDetailsDto;
+    cryptoWallet?: CryptoWalletDetailsDto;
+    digitalWallet?: DigitalWalletDetailsDto;
+    merchant?: MerchantDetailsDto;
+    processor?: ProcessorDetailsDto;
+    cash?: CashDetailsDto;
+    check?: CheckDetailsDto;
+    atm?: AtmDetailsDto;
+    other?: OtherPaymentDetailsDto;
+}
+export interface PaymentInfoDto {
+    /** Direction from the principal party's perspective. */
+    direction: 'IN' | 'OUT';
+    /** Currency in TYPE:CODE format (e.g. FIAT:USD, CRYPTO:BTC). */
+    originCurrency: string;
+    /** Amount in minor currency units (cents for USD, satoshis for BTC). */
+    originAmount: number;
+    /** Settlement amount in destination currency (minor units). */
+    destinationAmount?: number;
+    /** Destination currency when different from origin. */
+    destinationCurrency?: string;
+    /** Transaction fees. */
+    fees?: FeeDto[];
+    /** Account balance before this transaction (minor units). */
+    balanceBeforeTransaction?: number;
+    /** Account balance after this transaction (minor units). */
+    balanceAfterTransaction?: number;
+    /** Currency of the balance fields (TYPE:CODE format). Defaults to originCurrency. */
+    balanceCurrency?: string;
+}
+export interface PaymentLocationAddressDto {
+    /** Street address line 1. */
+    line1?: string;
+    /** Street address line 2. */
+    line2?: string;
+    /** City / town. */
+    city?: string;
+    /** State / province / region. */
+    state?: string;
+    /** Postal / ZIP code. */
+    postalCode?: string;
+    /** ISO 3166-1 alpha-3 country code. */
+    country?: string;
+}
+export interface PaymentLocationCoordinatesDto {
+    /** Latitude (WGS84). */
+    lat: number;
+    /** Longitude (WGS84). */
+    lng: number;
+}
+export interface PlaceOfBirthDto {
+    cityOfBirth?: string;
+    provinceOfBirth?: string;
+    /** ISO 3166-1 alpha-3 country code. */
+    countryOfBirth: string;
+}
+export interface PostalAddressDto {
+    /** Address type discriminator. */
+    type?: 'BIZZ' | 'DLVY' | 'HOME' | 'MLTO' | 'PBOX' | 'ADDR';
+    department?: string;
+    subDepartment?: string;
+    streetName?: string;
+    buildingNumber?: string;
+    buildingName?: string;
+    floor?: string;
+    postBox?: string;
+    room?: string;
+    postCode?: string;
+    townName?: string;
+    townLocationName?: string;
+    districtName?: string;
+    countrySubDivision?: string;
+    /** ISO 3166-1 alpha-3 country code. */
+    country: string;
+    /** Unstructured fallback (max 7 lines × 70 chars per ISO 20022). */
+    addressLines?: string[];
+    /** YYYY-MM-DD; address validity start. */
+    validFrom?: string;
+    /** YYYY-MM-DD; address validity end. */
+    validTo?: string;
+}
+export interface PrincipalPartyDto {
+    /** Customer identifier. Use the internal UUID directly, or prefix with `ext:` for your external ID (e.g. `ext:CUST-2847`). */
+    customerId: string;
+    /** Account identifier. Use the internal UUID directly, or prefix with `ext:` for your external ID (e.g. `ext:ACC-2847-001`). */
+    accountId: string;
+}
+export interface ProcessorDetailsDto {
+    /** Processor namespace (Stripe, Adyen, Braintree, …). Tier-2 key when paired with reference. */
+    namespace?: string;
+    /** Namespace-scoped reference identifier. CALLER CONTRACT (per spec ingestion/07 §5.1.3): use the processor's customer-level identifier (e.g. Stripe cus_*, Plaid acc_*), NOT per-transaction values like Stripe pi_*. */
+    reference?: string;
+    /** Caller-supplied stable rail identifier (tier-1 key per spec ingestion/07 §5.1.2). */
+    externalReference?: string;
+}
+export interface PushExchangeRatesDto {
+    /** Array of exchange rate entries to append */
+    rates: ExchangeRateEntryDto[];
+}
+export interface RegisterDeviceBrowserDetailsDto {
+    browserName: string;
+    browserMajorVersion?: string;
+    browserFullVersion?: string;
+    os: 'WINDOWS' | 'MACOS' | 'LINUX' | 'IOS' | 'ANDROID' | 'OTHER';
+    osVersion?: string;
+    device: 'DESKTOP' | 'MOBILE' | 'TABLET' | 'UNKNOWN';
+    userAgent?: string;
+}
+export interface RegisterDeviceDto {
+    /** Fingerprint provider identifier for the device */
+    fingerprint: string;
+    browserDetails: RegisterDeviceBrowserDetailsDto;
+    /** IP sessions observed for the device */
+    ipSessions?: unknown[];
+    botProbability?: number;
+    confidence?: number;
+}
+export interface RelatedTransactionDto {
+    /** Transaction ID of the related transaction. Use the same identifier format as `transactionId` (your external reference). */
+    transactionId: string;
+    /** Describes how this transaction relates to the current one (e.g. FEE, REVERSAL, FUNDING_LEG, SETTLEMENT, REFUND, SPLIT). */
+    relationship?: string;
+}
+export interface RequestUploadUrlDto {
+    /** Original file name */
+    fileName: string;
+    /** MIME type */
+    contentType: string;
+    /** Optional label or category */
+    label?: string;
+}
+export interface ResetMemberPasswordDto {
+    /** Member id (organization-scoped) of the user to reset */
+    memberId: string;
+}
+export interface RiskAssessmentAnswerDto {
+    questionId: string;
+    question: string;
+    answer: string;
+    score: number;
+    selectedOptionId?: string;
+    notes?: string;
+}
+export interface RiskQuestionnaireAnswerDto {
+    questionId: string;
+    question: string;
+    answer: string;
+    score: number;
+}
+export interface TaxIdentificationDto {
+    /** Tax identifier value. */
+    value: string;
+    /** ISO 3166-1 alpha-3 country code. */
+    country: string;
+    type: 'TIN' | 'VAT' | 'EIN' | 'GIIN' | 'OTHER';
+    issuer?: string;
+    /** YYYY-MM-DD */
+    registrationDate?: string;
+}
+export interface TransactionBodyDto {
+    /** Transaction kind discriminator. */
+    kind: 'TRANSFER' | 'ACCOUNT_ENTRY';
+    /** Two-level payment classification: closed category enum + open method string. */
+    mode: Record<string, unknown>;
+    /** Channel and session context for the transaction. */
+    channel?: ChannelDto;
+    /** Transaction status. */
+    status: 'PENDING' | 'PROCESSING' | 'COMPLETE' | 'REJECTED' | 'REVERSED';
+    /** Monetary details for this transaction. */
+    paymentInfo: PaymentInfoDto;
+    /** The customer initiating/owning this transaction. */
+    principalParty: PrincipalPartyDto;
+    /** The other party in this transaction. */
+    counterparty?: CounterpartyPayloadDto;
+    /** When the transaction was executed. Used for window calculations. */
+    executedAt: string;
+    /** Your internal reference or invoice number. */
+    reference?: string;
+    /** Free-text memo or note. */
+    memo?: string;
+    /** IDs of related transactions (e.g. funding legs, reversals, fees). Useful when multiple transactions form a single logical transfer. */
+    relatedTransactions?: RelatedTransactionDto[];
+    /** Open per-transaction key/value bag stored on `transactions.metadata` and exposed to the rules engine as `txn.metadata.{key}`. Each value is either a **bare primitive** (string / number / boolean — coerced to `text` at ingest) or a **typed wrapper** `{ "type": "...", "value": ... }` so the evaluator can run typed comparisons. See spec evaluation/02 §1.M.
+
+**Supported wrapper types:** `text`, `number`, `boolean`, `date` (ISO 8601), `set` (string array), `currency` (`TYPE:CODE`), `monetary` (`<amount>@<TYPE:CODE>` — normalised to minor units; pre-resolves an additional `txn.metadata.{key}.currency` payload path so cross-currency rules work).
+
+**Rejected at ingest (HTTP 422):** bare arrays (use `{"type":"set",...}`); bare objects without a `type`/`value` shape; unknown `type` values; `null`; currencies not in the tenant registry; malformed monetary literals.
+
+**Aggregate filters do not accept `metadata.*` keys** (audit AU25). Use first-class fields when something needs cross-transaction aggregation. */
+    metadata?: Record<string, string | number | boolean | MetadataTextWrapperDto | MetadataNumberWrapperDto | MetadataBooleanWrapperDto | MetadataDateWrapperDto | MetadataSetWrapperDto | MetadataCurrencyWrapperDto | MetadataMonetaryWrapperDto>;
+}
+export interface UpdateAccountDto {
+    /** Product ID this account is based on */
+    productId?: string;
+    label?: string;
+    /** Currency code (ISO 4217) */
+    currency?: string;
+    bankName?: string;
+    bankSwift?: string;
+    iban?: string;
+    accountNumber?: string;
+    /** Arbitrary key-value properties */
+    customProperties?: Record<string, unknown>;
+    /** Override account opening timestamp (ISO 8601). Used by data-loading tools to backfill historical accounts. */
+    openedAt?: string;
+}
+export interface UpdateConstantDto {
+    /** Constant type. If changed, `value` must be re-supplied in the new shape. */
+    type?: 'scalar' | 'monetary' | 'set' | 'range' | 'text' | 'number' | 'boolean' | 'date' | 'currency';
+    /** Payload shape depends on the constant's `type`. Pick the matching variant below. Validated at write time. */
+    value?: {
+        /** e.g. `"1000000@FIAT:USD"` = $10,000.00. Precision implied by currency: USD=2, JPY=0, BTC=8, ETH=9, USDT/USDC=6. */
+        value: string;
+    } | {
+        values: string[];
+    } | {
+        min: unknown;
+        max: unknown;
+    } | {
+        value: unknown;
+    };
+    /** Human-readable description. */
+    description?: string;
+}
+export interface UpdateCounterpartyDto {
+    name?: string;
+    description?: string;
+    identity?: 'INDIVIDUAL' | 'ENTITY' | 'UNKNOWN';
+    classification?: 'BANK_ACCOUNT' | 'WALLET' | 'MERCHANT' | 'FINANCIAL_INSTITUTION' | 'PAYMENT_NETWORK' | 'UNKNOWN';
+    /** ISO 3166-1 alpha-3 country code */
+    country?: string;
+    bankAccount?: BankAccountDetailsDto;
+    wallet?: CryptoWalletDetailsDto;
+    merchant?: MerchantDetailsDto;
+    institution?: InstitutionDetailsDto;
+}
+/** OpenAPI schema is empty; treated as an opaque key/value bag — narrow on the caller side. */
+export type UpdateCurrencyInput = Record<string, unknown>;
+export interface UpdateDeviceTrustDto {
+    trustLevel: 'KNOWN' | 'NEW' | 'SUSPICIOUS';
+}
+export interface UpdateEntityDto {
+    legalName?: string;
+    tradingNames?: string[];
+    registrationNumber?: string;
+    /** ISO 3166-1 alpha-3 country code */
+    countryOfIncorporation?: string;
+    dateOfIncorporation?: string;
+    entityType?: string;
+    /** Parent entity ID for subsidiaries */
+    parentEntityId?: string;
+    email?: string;
+    phone?: string;
+    addresses?: AddressDto[];
+    /**
+     * Generic key/value entries to upsert onto the entity record. Merge semantics —
+     * unlisted keys are left untouched.
+     */
+    otherInformation?: UpsertOtherInformationEntryInput[];
+    /**
+     * When set, marks the update as a merge from an approved identification document.
+     * Server emits an `idDoc.merged` activity (instead of the generic `customer.updated`)
+     * and tags any newly upserted otherInformation entries with this id as their `sourceId`.
+     */
+    sourceDocumentId?: string;
+    /** Override creation timestamp (ISO 8601). Used by data-loading tools to backfill historical entities. */
+    createdAt?: string;
+}
+export interface UpdateEventDefinitionDto {
+    /** Human-readable display name. */
+    displayName?: string;
+    /** Event description. */
+    description?: string;
+    /** Event category. */
+    category?: string;
+    /** Event properties schema. */
+    properties?: Record<string, unknown>[];
+}
+export interface UpdateExpectedActivityDto {
+    expectedMonthlyTransactionCount: number;
+    /** Amount in minor units */
+    expectedMonthlyVolume: number;
+    /** Amount in minor units */
+    expectedAvgTransactionSize?: number;
+    seasonalFluctuations?: boolean;
+    seasonalDescription?: string;
+}
+export interface UpdateFaceImageDto {
+    /** New URL to import; omit to keep the existing file. */
+    fileUrl?: string;
+    note?: string;
+}
+export interface UpdateIdentificationDocumentDto {
+    expiryDate?: string;
+    dateOfIssue?: string;
+    notes?: string;
+    attachments?: AttachmentDto[];
+}
+export interface UpdateIndividualDto {
+    fullName?: string;
+    preferredName?: string;
+    dateOfBirth?: string;
+    /** ISO 3166-1 alpha-3 country codes */
+    nationality?: string[];
+    /** ISO 3166-1 alpha-3 country codes */
+    countryOfResidence?: string[];
+    /** Additional name variants the customer is known by. */
+    aliases?: string[];
+    email?: string;
+    phone?: string;
+    identificationDocuments?: IdentificationDocumentDto[];
+    addresses?: AddressDto[];
+    /**
+     * Generic key/value entries to upsert onto the customer record. Merge semantics —
+     * unlisted keys are left untouched. Use this for fields without first-class columns
+     * (e.g. `sex`, `placeOfBirth`, fields extracted from an identification document).
+     */
+    otherInformation?: UpsertOtherInformationEntryInput[];
+    /**
+     * When set, marks the update as a merge from an approved identification document.
+     * Server emits an `idDoc.merged` activity (instead of the generic `customer.updated`)
+     * and tags any newly upserted otherInformation entries with this id as their `sourceId`.
+     */
+    sourceDocumentId?: string;
+    /** Override creation timestamp (ISO 8601). Used by data-loading tools to backfill historical customers. */
+    createdAt?: string;
+}
+export type CustomerOtherInformationSource = 'MANUAL' | 'IDENTIFICATION_DOCUMENT' | 'SYSTEM';
+export interface CustomerOtherInformationEntry {
+    id: string;
+    customerId: string;
+    key: string;
+    value: string;
+    source: CustomerOtherInformationSource;
+    /**
+     * Identifier of the source artifact when `source` is non-MANUAL.
+     * For `IDENTIFICATION_DOCUMENT` this is the document id that populated the entry.
+     */
+    sourceId?: string;
+    createdBy: UserRef;
+    updatedBy?: UserRef;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface UpsertOtherInformationEntryInput {
+    key: string;
+    value: string;
+    source?: CustomerOtherInformationSource;
+    sourceId?: string;
+}
+export interface BulkUpsertOtherInformationInput {
+    entries: UpsertOtherInformationEntryInput[];
+}
+/**
+ * Body for `PUT /customers/{customerId}/other-information/{key}` — the key
+ * travels in the URL path so only the value (and optional provenance) are in the body.
+ */
+export interface UpsertOtherInformationValueInput {
+    value: string;
+    source?: CustomerOtherInformationSource;
+    sourceId?: string;
+}
+export interface UpdateNoteDto {
+    /** Updated note text */
+    text?: string;
+}
+export interface UpdateProductDto {
+    /** Product name. */
+    name?: string;
+    /** Product description. */
+    description?: string;
+    /** Product status. */
+    status?: string;
+    /** Supported transaction method IDs. */
+    supportedMethodIds?: string[];
+    /** Arbitrary product metadata. */
+    metadata?: Record<string, unknown>;
+}
+export interface UpdateRiskRatingDto {
+    riskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+    /** Justification for the override */
+    justification?: string;
+}
+export interface UpdateRuleDto {
+    /** Rule name. */
+    name?: string;
+    /** Rule description. */
+    description?: string;
+    /** Rule subject. */
+    subject?: string;
+    /** Rule trigger. */
+    trigger?: string;
+    /** Rule severity. */
+    severity?: 'HIGH' | 'MEDIUM' | 'LOW';
+    /** Tags for categorisation. */
+    tags?: string[];
+    /** Rule status. */
+    status?: 'DRAFT' | 'ACTIVE' | 'DISABLED';
+    /** Condition tree. */
+    conditionTree?: Record<string, unknown>;
+    /** Actions to execute. */
+    actions?: string[];
+    /** Window period. */
+    windowPeriod?: string;
+}
+export interface UpdateStakeholderDto {
+    name?: string;
+    role?: 'SHAREHOLDER' | 'UBO' | 'DIRECTOR';
+    /** Ownership percentage (0–100) */
+    ownershipPercentage?: number;
+    /** ISO 3166-1 alpha-3 country code */
+    nationality?: string;
+    dateOfBirth?: string;
+    /** Link to an existing Individual customer */
+    individualId?: string;
+    /** Link to an existing Entity customer */
+    entityId?: string;
+}
+export interface UpdateWebhookDto {
+    /** Webhook destination name. */
+    name?: string;
+    /** Destination URL (must be HTTPS). */
+    url?: string;
+    /** Human-readable description. */
+    description?: string;
+    /** Event types to subscribe to. */
+    events?: string[];
+}
+export type ListIndividualsResponse = Paginated<IndividualResponseDto>;
+export type ListEntitiesResponse = Paginated<EntityResponseDto>;
+export type ListAccountsResponse = Paginated<AccountResponseDto>;
+export type ListCounterpartiesResponse = Paginated<CounterpartyResponseDto>;
+export interface IngestTransactionMatchAction {
+    type: string;
+}
+export interface IngestTransactionMatch {
+    ruleId: string;
+    ruleName: string;
+    severity: 'HIGH' | 'MEDIUM' | 'LOW';
+    flagReasons: string[];
+    actionsExecuted: IngestTransactionMatchAction[];
+}
+/** Synchronous response (200) from POST /v1/transactions. */
+export interface IngestTransactionResponse {
+    /** Echoed from request. */
+    transactionId: string;
+    /** Database record ID. */
+    id: string;
+    /** True if identical transactionId+timestamp was seen before. */
+    cached: boolean;
+    /** Unique evaluation run ID. */
+    evaluationId: string;
+    /** Total active rules checked. */
+    rulesEvaluated: number;
+    matches: IngestTransactionMatch[];
+    /** Server-side evaluation time in milliseconds. */
+    executionTimeMs: number;
+}
+/** Async response (202) from POST /v1/transactions when accepted for background processing. */
+export interface IngestTransactionAsyncResponse {
+    transactionId: string;
+    id: string;
+    async: true;
+    status: 'ACCEPTED' | string;
+}
+export interface IngestEventResponse {
+    /** Database record ID for the ingested event. */
+    eventId: string;
+    /** Echoed event type. */
+    type: string;
+}
+export interface CursorPaginationQuery {
+    cursor?: string;
+    limit?: number;
+}
+export interface ListCurrenciesQuery {
+    type?: string;
+    enabled?: boolean;
+    search?: string;
+}
+export interface SyncKeyQuery {
+    syncKey?: string;
+}
+export interface DeleteConstantQuery {
+    force?: boolean;
+    reason?: string;
+}
+export interface GetCustomerQuery {
+    /** If true, treat the path id as an external customer ID. */
+    isExternal?: boolean;
+}
+export type OpaqueResponse = Record<string, unknown>;
+export type ApiKeyResponseDto = OpaqueResponse;
+export type TokenResponseDto = OpaqueResponse;
+export type InvitationDetailsDto = OpaqueResponse;
+export type SetupStatusDto = OpaqueResponse;
+export type SetupInitializeResponseDto = OpaqueResponse;
+export type NoteResponseDto = OpaqueResponse;
+/**
+ * Response shape for `POST /v1/customers/{customerId}/files/upload-url`. The
+ * OpenAPI spec does not formally enumerate the response — the documented step-2
+ * inputs are the `fileKey` (echoed back on confirm) and `uploadUrl` (S3 PUT target).
+ */
+export interface UploadUrlResponseDto {
+    /** Opaque key — pass this to `confirmUpload` after PUT-ing the bytes. */
+    fileKey: string;
+    /** Presigned S3 PUT URL — upload the bytes here with a matching `Content-Type`. */
+    uploadUrl: string;
+    [key: string]: unknown;
+}
+/**
+ * Response shape for customer file endpoints (list / get / confirm). Confirm
+ * returns the materialised `CustomerFile` whose `id` is what
+ * `IdentificationDocument.attachments[].fileId` must reference.
+ */
+export type FileResponseDto = CustomerFile;
+/**
+ * Response shape for `POST /v1/platform/v1/files/upload-url`. The OpenAPI spec
+ * does not formally enumerate this — fields below are the documented step-2 inputs
+ * the caller is expected to use (`fileId` for later reference, `uploadUrl` to PUT bytes).
+ * Additional server-supplied fields (e.g. `expiresAt`) flow through as `unknown`.
+ */
+export interface PlatformUploadUrlResponseDto {
+    /** ID to reference in subsequent platform writes via `attachments[].fileId`. */
+    fileId: string;
+    /** Presigned PUT URL — upload the bytes here with a matching `Content-Type`. */
+    uploadUrl: string;
+    [key: string]: unknown;
+}
+/** Response shape for `POST /v1/platform/v1/files/confirm` — typically `{ fileId, downloadUrl, ... }`. */
+export type PlatformConfirmUploadResponseDto = OpaqueResponse;
+export type StakeholderResponseDto = OpaqueResponse;
+export type DeviceResponseDto = OpaqueResponse;
+export type DeviceSummaryDto = OpaqueResponse;
+export type RiskQuestionnaireResponseDto = OpaqueResponse;
+export type RiskAssessmentResponseDto = OpaqueResponse;
+export type ExpectedActivityResponseDto = OpaqueResponse;
+export type ScreeningResultDto = OpaqueResponse;
+export type ConfirmedMatchDto = OpaqueResponse;
+export type RuleResponseDto = OpaqueResponse;
+export type ConstantResponseDto = OpaqueResponse;
+export type ProductResponseDto = OpaqueResponse;
+export type CurrencyResponseDto = OpaqueResponse;
+export type EventDefinitionResponseDto = OpaqueResponse;
+export type WebhookResponseDto = OpaqueResponse;
+export type SyncExportDto = OpaqueResponse;
+export type ResetConfigResponseDto = OpaqueResponse;
+export type PushExchangeRatesResponseDto = OpaqueResponse;
+export type BulkCurrencyStatusResponseDto = OpaqueResponse;
+/** Bulk update body for `PATCH /v1/config/currencies/bulk-status` (schema undocumented). */
+export type BulkCurrencyStatusInput = Record<string, unknown>;
+//# sourceMappingURL=types.d.ts.map