@dossier-wiki/os-sdk 1.4.1 → 1.4.2-staging.6.1

package/dist/types.d.ts

@@ -187,6 +187,57 @@ export type TypedFieldStored = {
     currency: string;
     precision: number;
 };
+/**
+ * Read shape for one typed entry on responses that render the bag through
+ * the canonical `TypedFieldType` tag (uppercase) — e.g. customer profile
+ * fields (`IndividualResponseDto.fields`, `EntityResponseDto.fields`).
+ * Monetary entries carry pre-resolved minor units instead of `value`.
+ */
+export type TypedFieldValue = {
+    key: string;
+    type: 'TEXT';
+    value: string;
+} | {
+    key: string;
+    type: 'NUMBER';
+    value: number;
+} | {
+    key: string;
+    type: 'BOOLEAN';
+    value: boolean;
+} | {
+    key: string;
+    type: 'DATE';
+    value: string;
+} | {
+    key: string;
+    type: 'LIST';
+    value: string[];
+} | {
+    key: string;
+    type: 'SINGLE_SELECT';
+    value: string;
+} | {
+    key: string;
+    type: 'MULTI_SELECT';
+    value: string[];
+}
+/** @deprecated Legacy open list. */
+ | {
+    key: string;
+    type: 'SET';
+    value: string[];
+} | {
+    key: string;
+    type: 'CURRENCY';
+    value: string;
+} | {
+    key: string;
+    type: 'MONETARY';
+    amountMinor: number;
+    currency: string;
+    precision: number;
+};
 export interface UntypedKeyValueDto {
     key: string;
     value: unknown;
@@ -779,6 +830,18 @@ export interface CreateEntityInput {
     addresses?: AddressInputDto[];
     /** Parent entity for subsidiaries. */
     parentEntityId?: string;
+    /**
+     * Profile Template key (`ProfileTemplate.key`, e.g. `'entity-standard'`).
+     * Omit to use the default `ENTITY` template, if one is set. Must name a
+     * live template for entities.
+     */
+    profileTemplateKey?: string;
+    /**
+     * Typed profile fields declared by the profile template's `fieldConfig`
+     * (Tier A: unknown keys rejected, types enforced, required keys checked,
+     * defaults applied). Rejected when the customer ends up with no template.
+     */
+    fields?: TypedFieldValueInput[];
 }
 /** @deprecated Use `CreateEntityInput`. */
 export type CreateEntityDto = CreateEntityInput;
@@ -892,7 +955,21 @@ export interface CreateIndividualInput {
     /** @deprecated Use `phones`. Honoured only when `phones` is absent. */
     phone?: string;
     /** Override the creation timestamp (ISO 8601). For data-loading tools backfilling historical records. */
+    /** Skip the initial screening normally enqueued at creation, e.g. for a stakeholder screened with its entity. */
+    deferInitialScreening?: boolean;
     createdAt?: string;
+    /**
+     * Profile Template key (`ProfileTemplate.key`, e.g. `'individual-standard'`).
+     * Omit to use the default `INDIVIDUAL` template, if one is set. Must name
+     * a live template for individuals.
+     */
+    profileTemplateKey?: string;
+    /**
+     * Typed profile fields declared by the profile template's `fieldConfig`
+     * (Tier A: unknown keys rejected, types enforced, required keys checked,
+     * defaults applied). Rejected when the customer ends up with no template.
+     */
+    fields?: TypedFieldValueInput[];
 }
 /** @deprecated Use `CreateIndividualInput`. */
 export type CreateIndividualDto = CreateIndividualInput;
@@ -1152,6 +1229,14 @@ export interface EntityResponseDto {
     email?: string;
     phone?: string;
     riskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+    /** Who set `riskRating`. See `RiskRatingSource`. */
+    riskRatingSource?: RiskRatingSource | null;
+    /** When the next periodic review is due (YYYY-MM-DD), from the review cycle of the rating in force. */
+    nextReviewAt?: string | null;
+    /** Key of the customer's Profile Template; null when it has none. */
+    profileTemplateKey?: string | null;
+    /** Typed profile fields declared by the Profile Template. */
+    fields?: TypedFieldValue[];
     kycTier?: 'NO_KYC' | 'SDD' | 'CDD' | 'EDD' | 'ONGOING';
     /**
      * Standing assignment — the users/teams responsible for compliance work on
@@ -1495,6 +1580,14 @@ export interface IndividualResponseDto {
     email?: string;
     phone?: string;
     riskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+    /** Who set `riskRating`. See `RiskRatingSource`. */
+    riskRatingSource?: RiskRatingSource | null;
+    /** When the next periodic review is due (YYYY-MM-DD), from the review cycle of the rating in force. */
+    nextReviewAt?: string | null;
+    /** Key of the customer's Profile Template; null when it has none. */
+    profileTemplateKey?: string | null;
+    /** Typed profile fields declared by the Profile Template. */
+    fields?: TypedFieldValue[];
     kycTier?: 'NO_KYC' | 'SDD' | 'CDD' | 'EDD' | 'ONGOING';
     /**
      * Standing assignment — the users/teams responsible for compliance work on
@@ -2311,6 +2404,17 @@ export interface UpdateEntityDto {
     sourceDocumentId?: string;
     /** Override creation timestamp (ISO 8601). Used by data-loading tools to backfill historical entities. */
     createdAt?: string;
+    /**
+     * Switch the customer to another live `ENTITY` Profile Template. Kept
+     * profile values are re-validated against the new template.
+     */
+    profileTemplateKey?: string;
+    /**
+     * Profile field changes, validated against the Profile Template. Merge
+     * semantics: listed keys change, `value: null` clears a field, unlisted
+     * keys stay. Required fields must still be present afterwards.
+     */
+    fields?: TypedFieldValueInput[];
 }
 export interface UpdateEventDefinitionDto {
     /** Human-readable display name. */
@@ -2385,6 +2489,17 @@ export interface UpdateIndividualDto {
     sourceDocumentId?: string;
     /** Override creation timestamp (ISO 8601). Used by data-loading tools to backfill historical customers. */
     createdAt?: string;
+    /**
+     * Switch the customer to another live `INDIVIDUAL` Profile Template. Kept
+     * profile values are re-validated against the new template.
+     */
+    profileTemplateKey?: string;
+    /**
+     * Profile field changes, validated against the Profile Template. Merge
+     * semantics: listed keys change, `value: null` clears a field, unlisted
+     * keys stay. Required fields must still be present afterwards.
+     */
+    fields?: TypedFieldValueInput[];
 }
 export type CustomerOtherInformationSource = 'MANUAL' | 'IDENTIFICATION_DOCUMENT' | 'SYSTEM';
 export interface CustomerOtherInformationEntry {
@@ -2445,10 +2560,26 @@ export interface UpdateProductDto {
     /** Untyped escape hatch (Tier C). */
     otherProperties?: UntypedKeyValueInput[];
 }
+/**
+ * Body for `PUT /customers/{customerId}/risk-rating`. The rating becomes a
+ * sticky officer override (`riskRatingSource: 'MANUAL'`): a Profile
+ * Template's risk matrix keeps recording its computed rating but never
+ * overwrites this one until `customers.riskRating.clearOverride` is called.
+ * Needs a key whose creator is an owner, admin or compliance member
+ * (`riskRating:override`); others get 403.
+ */
 export interface UpdateRiskRatingDto {
     riskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
-    /** Justification for the override */
-    justification?: string;
+    /** Why the rating is set by hand (required, at most 2,000 characters). Kept on the customer's risk history. */
+    justification: string;
+}
+/** Response of `PUT /customers/{customerId}/risk-rating`. */
+export interface UpdateRiskRatingResponseDto {
+    customerId: string;
+    previousRiskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL' | null;
+    currentRiskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+    justification: string | null;
+    updatedAt: string;
 }
 /** Lifecycle status of a customer (individual or entity). */
 export type CustomerStatus = 'ONBOARDING' | 'IN_REVIEW' | 'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | 'REJECTED';
@@ -2760,7 +2891,42 @@ export interface DeviceResponseDto {
 }
 /** @deprecated Customer Device endpoints now return the canonical Device response. */
 export type DeviceSummaryDto = DeviceResponseDto;
-export type CustomerRiskAssessmentResponseDto = OpaqueResponse;
+/**
+ * A Customer Risk Assessment: an analyst questionnaire
+ * (`method: 'QUESTIONNAIRE'`), a Profile Template risk matrix run
+ * (`method: 'MATRIX'`) or an officer override (`method: 'OVERRIDE'`). Matrix runs carry `compositeScore`, the factor-by-factor
+ * `breakdown`, the template version they ran against, what triggered them,
+ * and the outcome (`requiredDueDiligence`, `nextReviewAt`). For matrix runs
+ * `totalScore` is `round(compositeScore × 100)` and `answers` is empty.
+ */
+export interface CustomerRiskAssessmentResponseDto {
+    id: string;
+    customerId: string;
+    completedAt: string;
+    totalScore: number;
+    computedRiskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+    resultingRiskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+    ratingOverridden: boolean;
+    overrideJustification?: string;
+    narrative?: string;
+    answers: CustomerRiskAssessmentAnswerDto[];
+    files?: RiskAssessmentFileDto[];
+    method: RiskAssessmentMethod;
+    /** Weighted composite score of a matrix run (an intermediate number, not the rating). Null for questionnaires. */
+    compositeScore?: number | null;
+    /** Factor-by-factor breakdown of a matrix run. Null for questionnaires. */
+    breakdown?: RiskMatrixBreakdown | null;
+    /** The Profile Template a matrix run evaluated. */
+    profileTemplateId?: string | null;
+    /** The Profile Template version a matrix run evaluated. */
+    profileTemplateVersion?: number | null;
+    trigger?: RiskAssessmentTrigger | null;
+    /** Due diligence the matrix outcome requires. */
+    requiredDueDiligence?: DueDiligenceTier | null;
+    /** When the next periodic review is due (YYYY-MM-DD). */
+    nextReviewAt?: string | null;
+    [key: string]: unknown;
+}
 export type RiskAssessmentResponseDto = OpaqueResponse;
 export type ExpectedActivityResponseDto = OpaqueResponse;
 export type ScreeningResultDto = OpaqueResponse;
@@ -2953,8 +3119,50 @@ export interface IndividualCreatedResponseDto extends IndividualResponseDto {
 export interface EntityCreatedResponseDto extends EntityResponseDto {
     screening?: InitialScreeningResultDto;
 }
-/** KYC verification status, mirroring the backend `KYCVerificationStatus` enum. */
-export type KycVerificationStatus = 'VERIFIED' | 'FAILED' | 'PENDING' | 'EXPIRED';
+/**
+ * KYC verification status, mirroring the backend `KYCVerificationStatus` enum.
+ * `IN_REVIEW`: the customer finished and an officer must approve or reject.
+ */
+export type KycVerificationStatus = 'VERIFIED' | 'FAILED' | 'PENDING' | 'IN_REVIEW' | 'EXPIRED';
+/** An officer's decision on a finished KYC session. */
+export type KycReviewDecision = 'APPROVED' | 'REJECTED';
+/**
+ * Body of `POST /v1/customers/{customerId}/kyc/sessions/{sessionId}/review`.
+ */
+export interface ReviewKycSessionInput {
+    decision: KycReviewDecision;
+    /** Internal reason, visible to officers only. Required when rejecting. */
+    reason?: string | null;
+    /** Email the decision to the customer's primary email address. */
+    notifyCustomer?: boolean | null;
+    /** Customer-facing message included in the decision email. */
+    customerMessage?: string | null;
+}
+/** An officer's decision on a finished session — the verdict of record. */
+export interface KycSessionReviewDto {
+    decision: KycReviewDecision;
+    /** Internal reason, visible to officers only. */
+    reason?: string | null;
+    /** The message emailed to the customer, if they were notified. */
+    customerMessage?: string | null;
+    reviewerId?: string | null;
+    reviewerName: string;
+    /** ISO-8601 decision time. */
+    reviewedAt: string;
+}
+/** Body of `POST /v1/customers/{customerId}/kyc/sessions` — both fields optional. */
+export interface StartKycSessionInput {
+    /**
+     * The KYC provider config to verify with. Required when the organization
+     * has more than one enabled provider.
+     */
+    providerConfigId?: string | null;
+    /**
+     * The provider workflow to run. Defaults to the provider config's default
+     * workflow, then the provider's own default.
+     */
+    workflowId?: string | null;
+}
 /**
  * Result of starting a KYC session
  * (`POST /v1/customers/{customerId}/kyc/sessions`). Hand `sessionUrl` to the
@@ -2965,6 +3173,12 @@ export interface StartKycSessionResponseDto {
     sessionId: string;
     /** The provider's own session id. */
     providerSessionId: string;
+    /** The KYC provider config that runs the session. */
+    providerConfigId?: string | null;
+    /** The provider workflow the session runs; null = the provider's default. */
+    workflowId?: string | null;
+    /** Workflow name, snapshotted when the session started. */
+    workflowName?: string | null;
     /** Hosted URL the customer visits to complete verification. */
     sessionUrl: string;
     status: KycVerificationStatus;
@@ -2981,8 +3195,14 @@ export interface KycSessionDto {
     id: string;
     customerId: string;
     status: KycVerificationStatus;
-    /** Which provider ran the session, e.g. `dossiers`. */
+    /** Which provider ran the session, e.g. `dossiers` or `didit`. */
     provider?: string | null;
+    /** The KYC provider config that ran the session. */
+    providerConfigId?: string | null;
+    /** The provider workflow the session ran; null = the provider's default. */
+    workflowId?: string | null;
+    /** Workflow name, snapshotted when the session started. */
+    workflowName?: string | null;
     /** Hosted URL the customer visits to complete verification. */
     sessionUrl?: string | null;
     /** Per-step verification progress (provider-normalized). */
@@ -2996,6 +3216,15 @@ export interface KycSessionDto {
     createdAt: string;
     /** ISO-8601 completion time, if completed. */
     completedAt?: string | null;
+    /** The officer's decision, once made. Once set, `status` follows it. */
+    review?: KycSessionReviewDto | null;
+    /** ISO-8601 time of the last reconcile with the provider. */
+    syncedAt?: string | null;
+    /**
+     * ISO-8601 time the provider deleted or purged its copy. From then on this
+     * record is the only one — the OS is the system of record for KYC sessions.
+     */
+    providerDeletedAt?: string | null;
     [key: string]: unknown;
 }
 /**
@@ -3237,9 +3466,44 @@ export interface SyncConfig {
      * supplied fields update only those values.
      */
     behaviorSettings?: SyncBehaviorSettingsConfig;
+    /** Customer Profile Templates, keyed by the template `key` (e.g. "individual-standard"). */
+    profileTemplates?: Record<string, SyncProfileTemplateConfig>;
     customerFieldPolicy?: Record<string, SyncCustomerFieldPolicyConfig>;
     accountStatusPolicy?: SyncAccountStatusPolicyConfig;
 }
+/**
+ * A customer Profile Template in tenant sync. The template `key` lives in the
+ * section key. `fieldConfig`, `riskMatrix` and `kycWorkflows` use the stored
+ * shapes exactly (what export emits).
+ */
+export interface SyncProfileTemplateConfig {
+    name: string;
+    description?: string;
+    /** Immutable once created. */
+    partyType: ProfileTemplatePartyType;
+    /** At most one default per party type. Omitted = false. */
+    isDefault?: boolean;
+    /** Typed profile fields (same shape as a Product's `accountFieldConfig`). */
+    fieldConfig?: TypedFieldDefinition[];
+    /** Omitted or null = no matrix. */
+    riskMatrix?: RiskMatrix | null;
+    /**
+     * KYC workflow per purpose. `providerConfigId` is an org-local KYC provider
+     * config uuid, validated against the tenant at apply time.
+     */
+    kycWorkflows?: KycWorkflowBinding[];
+    /**
+     * Creation setup for an `INDIVIDUAL` template — how Add Individual creates
+     * customers of it. Full replacement when present; omitted = unmanaged
+     * (left as is; a new template copies the org's current preference). Give
+     * every preset / document type an explicit `id`, or the server mints a
+     * new one on each apply. Tags must be in the `customer.tags` catalogue;
+     * preset user / team ids are org-local — both checked at apply time.
+     */
+    individualCreation?: UpdateSimpleCustomerCreationPreferencesInput;
+    /** Same as `individualCreation`, for an `ENTITY` template (registration types, stakeholders). */
+    entityCreation?: UpdateSimpleEntityCreationPreferencesInput;
+}
 export interface SyncBehaviorSettingsConfig {
     attemptRetentionDays?: number;
     attemptCoverage?: 'ALL' | 'SELECTIVE';
@@ -3384,6 +3648,7 @@ export interface SyncPlan {
     tagCatalogue: SyncDiffOp[];
     assignmentPolicies: SyncDiffOp[];
     behaviorSettings: SyncDiffOp[];
+    profileTemplates: SyncDiffOp[];
     immutableViolations: SyncImmutableViolation[];
 }
 /** `POST /v1/config/sync/validate` response. */
@@ -4297,6 +4562,31 @@ export interface UpdateAlertNotesDto {
     /** Markdown. Null or empty clears the notes. */
     notes?: string | null;
 }
+/** Body of `alerts.dependencies.add`. */
+export interface AddAlertDependencyDto {
+    /** The alert that must close first. Not the alert itself, and not one that already waits on it. */
+    blockedByAlertId: string;
+}
+/** A "blocked by" link: `alertId` cannot be resolved or closed while `blockedByAlertId` is open. */
+export interface AlertDependencyDto {
+    id: string;
+    /** The alert that waits. */
+    alertId: string;
+    /** The alert that must close first. */
+    blockedByAlertId: string;
+    createdBy: {
+        userId: string;
+        name: string;
+    };
+    createdAt: string;
+}
+/** Both sides of an alert's links. Links outlive closure — check each linked alert's status to see which still block. */
+export interface AlertDependenciesResponseDto {
+    /** Links on which the alert waits, oldest first. */
+    blockedBy: AlertDependencyDto[];
+    /** Links where the alert is the one that must close first, oldest first. */
+    blocks: AlertDependencyDto[];
+}
 /** Flat REST view of an alert (any type). The GraphQL surface carries the rich per-type shape. */
 export interface AlertResponseDto {
     id: string;
@@ -4320,9 +4610,616 @@ export interface AlertResponseDto {
     disposition: string | null;
     dispositionReason: string | null;
     closedAt: string | null;
+    /** True while at least one blocking alert (`alerts.dependencies`) is open; the alert cannot be resolved or closed until they close. */
+    isBlocked?: boolean;
     createdAt: string;
     updatedAt: string;
     /** Present on `alerts.create` and `alerts.get`. */
     resources?: AlertResourceDto[];
 }
+/** Party type a Profile Template applies to (matches the customer `type`). */
+export type ProfileTemplatePartyType = 'INDIVIDUAL' | 'ENTITY';
+/** A risk level or rating — the platform's `risk_rating` vocabulary. */
+export type RiskLevel = 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+/** The due-diligence tiers a risk matrix outcome may demand (a subset of `kycTier`). */
+export type DueDiligenceTier = 'SDD' | 'CDD' | 'EDD';
+/**
+ * Who set a customer's current risk rating.
+ *
+ * - `MANUAL` — an officer set it (`customers.riskRating.update`, or a
+ *   questionnaire assessment). Sticky: the risk matrix records its computed
+ *   rating but never overwrites a MANUAL rating until the override is cleared
+ *   (`customers.riskRating.clearOverride`).
+ * - `MATRIX` — computed by the customer's Profile Template risk matrix.
+ * - `null` — set before Profile Templates existed (or never set).
+ */
+export type RiskRatingSource = 'MANUAL' | 'MATRIX';
+/**
+ * How a customer risk assessment was produced. `OVERRIDE` is an officer setting
+ * the final rating by hand: `overrideJustification` holds why,
+ * `computedRiskRating` what the risk matrix last computed.
+ */
+export type RiskAssessmentMethod = 'QUESTIONNAIRE' | 'MATRIX' | 'OVERRIDE';
+/** What made a risk matrix run. `SCREENING`: a screening match on the customer was confirmed, dismissed or reset. */
+export type RiskAssessmentTrigger = 'PROFILE_UPDATED' | 'KYC_SYNC' | 'SCREENING' | 'SCHEDULED' | 'TEMPLATE_CHANGED' | 'MANUAL';
+/** What a template's KYC workflow is for. Only `ONBOARDING` is used today. */
+export type KycWorkflowPurpose = 'ONBOARDING' | 'ENHANCED_DUE_DILIGENCE' | 'PERIODIC_REVIEW' | 'ALERT';
+/** A provider KYC workflow a Profile Template runs for one purpose (at most one per purpose). */
+export interface KycWorkflowBinding {
+    purpose: KycWorkflowPurpose;
+    /** The KYC provider config the workflow belongs to. */
+    providerConfigId: string;
+    /** The provider's workflow id (not the composite GraphQL `KycWorkflow.id`). */
+    workflowId: string;
+    /** What a verified session of this workflow writes back to the customer. Applied once, on verification. */
+    mappings?: KycOutputMapping[] | null;
+}
+/**
+ * One KYC output mapping: a value of a verified session written to a profile
+ * field or a customer-level constant.
+ *
+ * `source` is a session value: `form.<fieldId>` (a form answer, by the
+ * workflow's form field id) or one of `person.nationality`,
+ * `person.dateOfBirth`, `person.gender`, `person.placeOfBirth`,
+ * `document.type`, `document.issuingCountry`, `signals.ipCountry`,
+ * `signals.vpnOrTor`, `signals.disposableEmail`, `signals.disposablePhone`,
+ * `session.workflowName`, `session.verified` (always true). Countries are ISO
+ * 3166-1 alpha-3.
+ *
+ * `target` is `fields.<key>` (a TEXT, NUMBER, BOOLEAN, DATE, SINGLE_SELECT,
+ * MULTI_SELECT, LIST, SET or CURRENCY profile field of the template) or
+ * `$customer.<name>` (a customer-scope constant of type text, scalar,
+ * number, boolean, date, currency or set). Validated when the template is
+ * saved; a value the target cannot hold is skipped at run time.
+ */
+export interface KycOutputMapping {
+    source: string;
+    target: string;
+    /** Session value → target value. Matching ignores case and surrounding spaces; unmapped values pass through. */
+    valueMap?: KycValueMapEntry[] | null;
+    /** `FILL` (default) writes only an empty target; `OVERWRITE` replaces what is there. */
+    mode?: 'FILL' | 'OVERWRITE' | null;
+}
+export interface KycValueMapEntry {
+    from: string;
+    to: string;
+}
+/** The item score a risk level contributes before weighting, e.g. `{ level: 'HIGH', score: 12.5 }`. */
+export interface RiskScaleEntry {
+    level: RiskLevel;
+    score: number;
+}
+/**
+ * Composite score below `below` maps to `rating`. Bands are ascending; the
+ * last band omits `below` (no upper bound).
+ */
+export interface RiskBand {
+    rating: RiskLevel;
+    below?: number | null;
+}
+/**
+ * The level one option of a select field — or of a BOOLEAN field, whose
+ * options are `"true"` and `"false"` — scores.
+ */
+export interface RiskOptionLevel {
+    option: string;
+    level: RiskLevel;
+    /**
+     * This option's own points, overriding the level's score from the scale.
+     * The level still drives display and escalations. Non-negative.
+     */
+    score?: number | null;
+}
+/**
+ * One band of a NUMBER or MONETARY field: `min` inclusive, `max` exclusive,
+ * either end open (null/omitted). Bands may leave gaps — a value in a gap
+ * scores as unmatched — but never overlap. Money compares in major units of
+ * the field's own currency (no conversion).
+ */
+export interface RiskRange {
+    min?: number | null;
+    max?: number | null;
+    level: RiskLevel;
+    /** This band's own points, overriding the level's score from the scale. Non-negative. */
+    score?: number | null;
+}
+/** An ordered criterion of a factor; the first one whose condition holds sets the level. */
+export interface RiskCriterion {
+    label: string;
+    level: RiskLevel;
+    /** This criterion's own points, overriding the level's score from the scale. Non-negative. */
+    score?: number | null;
+    /**
+     * Condition tree, same grammar and operators as a rule condition tree
+     * (spatial operators excluded). May read `fields.<key>` (this template's
+     * profile fields), a fixed set of `customer.*` fields (`type`,
+     * `kycStatus`, `country`, `entityType`, `tags`, `isHighRisk`,
+     * `isWatchlisted`, and the `RiskMatrixDerivedInput`s), and `$global.*` /
+     * `$customer.*` constants.
+     */
+    when: Record<string, unknown>;
+}
+/**
+ * Inputs a risk matrix factor can read that the platform derives itself,
+ * so the CRM need not push them as picklist answers:
+ *
+ * - `customer.nationality` — ISO-3 codes: an individual's nationalities, an
+ *   entity's country of incorporation (a list);
+ * - `customer.productKeys` — the product key (`syncKey`, else `externalId`)
+ *   of every account the customer owns that is not closed (a list);
+ * - `customer.expectedMonthlyVolume` — from the expected activity profile
+ *   (a number).
+ *
+ * Conditions (criteria, escalations) can read them too.
+ */
+export type RiskMatrixDerivedInput = 'customer.nationality' | 'customer.productKeys' | 'customer.expectedMonthlyVolume';
+/**
+ * One weighted dimension of a risk matrix. Exactly one form per factor:
+ *
+ * - **option map** — `field` + `levels`: a SINGLE_SELECT / MULTI_SELECT
+ *   profile field (every option gets a level) or a BOOLEAN field (options
+ *   `"true"` / `"false"`). A MULTI_SELECT scores its selected option with the
+ *   highest score;
+ * - **range map** — `field` + `ranges`: a NUMBER or MONETARY field;
+ * - **derived input** — `input` instead of `field`: a value the platform
+ *   derives itself (see `RiskMatrixDerivedInput`). A list input takes
+ *   `levels` (option = a value; when several are held the riskiest scores)
+ *   or `criteria`; a number takes `ranges`;
+ * - **criteria** — explicit ordered condition trees, for anything else.
+ *
+ * Each option, band or criterion scores its level's scale score unless it
+ * sets its own `score`; the factor's `weight` then scales it.
+ */
+export interface RiskFactor {
+    /** Stable key; escalations read the result as `factor.<key>.level`. */
+    key: string;
+    label: string;
+    /** Share of the composite, 0 < weight ≤ 1. All factor weights sum to 1. */
+    weight: number;
+    /** Level when nothing matches (input missing). Defaults to the highest level in the scale. */
+    whenUnmatched?: RiskLevel | null;
+    /** Option- or range-map form: key of the profile field the factor reads. */
+    field?: string | null;
+    /** Derived-input form: the platform-derived input the factor reads instead of a profile field. */
+    input?: RiskMatrixDerivedInput | null;
+    /** Option-map form: the level (and optional score) each option of `field` scores. */
+    levels?: RiskOptionLevel[] | null;
+    /** Range-map form: the level (and optional score) each band of a number/money `field` scores. */
+    ranges?: RiskRange[] | null;
+    /** Explicit form: ordered criteria, first match wins. */
+    criteria?: RiskCriterion[] | null;
+}
+/** A floor: when `when` holds, the final rating is at least `minimumRating`. Never lowers a rating. */
+export interface RiskEscalation {
+    label: string;
+    minimumRating: RiskLevel;
+    /** Condition tree; may also read `factor.<key>.level` and `factor.<key>.criterion`. */
+    when: Record<string, unknown>;
+}
+/** What a final rating demands. */
+export interface RiskOutcome {
+    rating: RiskLevel;
+    requiredDueDiligence: DueDiligenceTier;
+    /** Months until the next periodic review. */
+    reviewEveryMonths: number;
+}
+/**
+ * A Profile Template's weighted factor model: per-factor level → item score
+ * × weight → composite score → band (preliminary rating) → escalation floors
+ * → final rating → outcome. Validated when the template is saved (weights sum
+ * to 1, every option of a bound field levelled, every level without its own
+ * score in the scale, ranges never overlap, an outcome for every reachable
+ * rating, conditions read only what a matrix may).
+ */
+export interface RiskMatrix {
+    scale: RiskScaleEntry[];
+    bands: RiskBand[];
+    factors: RiskFactor[];
+    escalations: RiskEscalation[];
+    outcomes: RiskOutcome[];
+}
+/** A profile field (`fields.<key>`) or derived input (`customer.<input>`) a matrix run read, with its value then. */
+export interface RiskInputValue {
+    path: string;
+    value?: unknown;
+}
+/** One factor's result in a matrix run. */
+export interface RiskFactorResult {
+    key: string;
+    label: string;
+    weight: number;
+    /** The payload path the factor read; null for a criteria-only factor or a run stored before it was recorded. */
+    path?: string | null;
+    /** The value the factor read (a profile field or derived input; a list for list inputs); null when missing or the factor has no bound input. */
+    input?: unknown;
+    /** The matched criterion's label; null when nothing matched. */
+    criterion?: string | null;
+    level: RiskLevel;
+    score: number;
+    weighted: number;
+    matched: boolean;
+}
+/** An escalation that fired in a matrix run. */
+export interface RiskEscalationResult {
+    label: string;
+    minimumRating: RiskLevel;
+    /** The profile values its condition read. Null on runs stored before they were recorded. */
+    inputs?: RiskInputValue[] | null;
+}
+/** Everything needed to reproduce a matrix rating by hand. */
+export interface RiskMatrixBreakdown {
+    factors: RiskFactorResult[];
+    /** The composite score — an intermediate number mapped to a rating by the bands. */
+    composite: number;
+    preliminaryRating: RiskLevel;
+    /** Escalations that fired. */
+    escalations: RiskEscalationResult[];
+    /** Keys of factors scored at their fallback level because the input was missing. */
+    incompleteFactors: string[];
+    finalRating: RiskLevel;
+    outcome?: RiskOutcome | null;
+    /** Every profile value the run read (factor inputs and escalation conditions). Null on runs stored before it was recorded. */
+    inputs?: RiskInputValue[] | null;
+    /** The scale the run scored levels on. Null on older runs. */
+    scale?: RiskScaleEntry[] | null;
+    /** The bands the run placed the composite in. Null on older runs. */
+    bands?: RiskBand[] | null;
+}
+/** A Profile Template as returned by `/v1/config/profile-templates`. */
+export interface ProfileTemplate {
+    id: string;
+    /** Immutable, org-unique key used by connectors and Tenant Sync (e.g. `individual-standard`). */
+    key: string;
+    name: string;
+    description?: string | null;
+    /** `CUSTOMER` today. */
+    resourceType: string;
+    partyType: ProfileTemplatePartyType;
+    /** New customers of this party type get this template when none is named. */
+    isDefault: boolean;
+    /** Current published version. */
+    version: number;
+    fieldConfig: TypedFieldDefinition[];
+    riskMatrix?: RiskMatrix | null;
+    kycWorkflows: KycWorkflowBinding[];
+    /**
+     * How the Add Individual form creates customers of this template.
+     * Set on `INDIVIDUAL` templates only (null on entity templates). Null on
+     * an individual template means it has no setup of its own and the
+     * org-wide Simple Customer Creation preference applies.
+     */
+    individualCreation: SimpleCustomerCreationPreferences | null;
+    /** The `ENTITY` counterpart of `individualCreation` (null on individual templates). */
+    entityCreation: SimpleEntityCreationPreferences | null;
+    archivedAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** A part of the template definition a version changed. */
+export type ProfileTemplateVersionChange = 'FIELDS' | 'RISK_MATRIX' | 'KYC_WORKFLOWS' | 'CREATION';
+/** An immutable snapshot of one published template version. */
+export interface ProfileTemplateVersion {
+    version: number;
+    fieldConfig: TypedFieldDefinition[];
+    riskMatrix?: RiskMatrix | null;
+    kycWorkflows: KycWorkflowBinding[];
+    /** The version's Add Individual setup (individual templates). Null = the org-wide preference applied. */
+    individualCreation: SimpleCustomerCreationPreferences | null;
+    /** The version's Add Entity setup (entity templates). Null = the org-wide preference applied. */
+    entityCreation: SimpleEntityCreationPreferences | null;
+    /** What this version changed from the one before. Empty for version 1. */
+    changes: ProfileTemplateVersionChange[];
+    /** Actor who published the version. */
+    createdBy: Record<string, unknown>;
+    createdAt: string;
+}
+/** Body for `POST /v1/customers/profile-template-assignment`. */
+export interface AssignProfileTemplateInput {
+    /** Customers to put on the template (at most 500). */
+    customerIds: string[];
+    /** Key of a live template. Customers of the other party type are skipped. */
+    profileTemplateKey: string;
+}
+/** What a bulk template assignment did to each customer. */
+export interface ProfileTemplateAssignmentResult {
+    /**
+     * Customers now on the template. `missingFields` lists required profile
+     * fields left empty: the customer is incomplete until a profile edit
+     * fills them (any later `fields` update must include them).
+     */
+    assigned: {
+        customerId: string;
+        missingFields: string[];
+    }[];
+    /** Customers already on the template; left as they were. */
+    unchanged: string[];
+    /** Customers of the other party type, archived customers and unknown ids, with why. */
+    skipped: {
+        customerId: string;
+        reason: string;
+    }[];
+}
+/** Query for `GET /v1/config/profile-templates`. */
+export interface ListProfileTemplatesQuery {
+    partyType?: ProfileTemplatePartyType;
+    /** Include archived templates (default false). */
+    includeArchived?: boolean;
+}
+/** Body for `POST /v1/config/profile-templates`. */
+export interface CreateProfileTemplateInput {
+    /** Immutable, org-unique key: lowercase letters and digits separated by `-` or `_` (max 64). */
+    key: string;
+    /** Max 200 characters. */
+    name: string;
+    description?: string | null;
+    partyType: ProfileTemplatePartyType;
+    /** Make this the default for its party type; the previous default stops being default. */
+    isDefault?: boolean;
+    fieldConfig?: TypedFieldDefinition[];
+    riskMatrix?: RiskMatrix | null;
+    kycWorkflows?: KycWorkflowBinding[];
+    /**
+     * Creation setup for the Add Individual form. `INDIVIDUAL` templates only
+     * — sending it on an entity template is a 400. Omit (or null) to copy the
+     * org's current Simple Customer Creation preference.
+     */
+    individualCreation?: UpdateSimpleCustomerCreationPreferencesInput | null;
+    /**
+     * Creation setup for the Add Entity form. `ENTITY` templates only —
+     * sending it on an individual template is a 400. Omit (or null) to copy
+     * the org's current simple entity-creation preference.
+     */
+    entityCreation?: UpdateSimpleEntityCreationPreferencesInput | null;
+}
+/**
+ * Body for `PATCH /v1/config/profile-templates/{id}`. `key` and `partyType`
+ * are immutable. `riskMatrix: null` removes the matrix. Any change to
+ * `fieldConfig`, `riskMatrix`, `kycWorkflows` or the creation setup publishes
+ * a new version; only `fieldConfig` / `riskMatrix` changes re-assess the
+ * template's customers. Archived templates cannot be changed.
+ */
+export interface UpdateProfileTemplateInput {
+    /**
+     * The version this edit was based on. When the template has been saved
+     * since, the update is refused with 409 instead of overwriting the newer
+     * version. Send it from any read-modify-write flow.
+     */
+    expectedVersion?: number;
+    name?: string;
+    description?: string | null;
+    isDefault?: boolean;
+    fieldConfig?: TypedFieldDefinition[];
+    riskMatrix?: RiskMatrix | null;
+    kycWorkflows?: KycWorkflowBinding[];
+    /**
+     * Replace the Add Individual creation setup (`INDIVIDUAL` templates
+     * only; 400 on an entity template). `null` clears it, so the org-wide
+     * preference applies again. Omit to keep it.
+     */
+    individualCreation?: UpdateSimpleCustomerCreationPreferencesInput | null;
+    /**
+     * Replace the Add Entity creation setup (`ENTITY` templates only; 400 on
+     * an individual template). `null` clears it. Omit to keep it.
+     */
+    entityCreation?: UpdateSimpleEntityCreationPreferencesInput | null;
+}
+/** Body for `POST /v1/config/profile-templates/{id}/risk-matrix-impact`. */
+export interface RiskMatrixImpactInput {
+    /** The draft's profile fields; factors may only read these. */
+    fieldConfig?: TypedFieldDefinition[];
+    riskMatrix: RiskMatrix;
+}
+/** Body for `POST /v1/config/profile-templates/preview-risk-matrix`. */
+export interface PreviewRiskMatrixInput extends RiskMatrixImpactInput {
+    /** The customer to score. */
+    customerId: string;
+}
+/** One customer scored under a draft matrix. */
+export interface RiskMatrixPreview {
+    customerId: string;
+    customerName: string;
+    externalId: string;
+    /** The rating in force now. */
+    currentRating?: RiskLevel | null;
+    /** An officer override is in force, so a different computed rating would not apply. */
+    overrideActive: boolean;
+    /** The customer's own template's saved matrix, evaluated now; null when it has none. */
+    published?: RiskMatrixBreakdown | null;
+    draft: RiskMatrixBreakdown;
+}
+/** How many evaluated customers hold a rating before and after the draft. */
+export interface RiskRatingDistribution {
+    rating: RiskLevel;
+    before: number;
+    after: number;
+}
+/** Customers moving from one rating to another; `from` is null for unrated customers. */
+export interface RiskRatingMovement {
+    from?: RiskLevel | null;
+    to: RiskLevel;
+    count: number;
+}
+/** A customer whose rating the draft would move. */
+export interface RiskImpactCustomer {
+    customerId: string;
+    customerName: string;
+    externalId: string;
+    /** The saved matrix's rating; the current rating when the template has no matrix yet. */
+    from?: RiskLevel | null;
+    to: RiskLevel;
+    compositeBefore?: number | null;
+    compositeAfter: number;
+    /** An officer override is in force: this customer's rating would not move. */
+    overrideActive: boolean;
+}
+/** What saving a draft matrix would do to the live customers on its template. */
+export interface RiskMatrixImpact {
+    /** Live customers on the template. */
+    customerCount: number;
+    evaluated: number;
+    /** More customers than the dry-run limit (default 5,000); only the first `evaluated` were scored. */
+    truncated: boolean;
+    /** Customers whose matrix rating moves. */
+    changed: number;
+    /** Of those, customers with an officer override in force, whose rating stays. */
+    overriddenChanged: number;
+    /** Customers with a factor scored at its fallback level under the draft. */
+    incomplete: number;
+    failed: number;
+    distribution: RiskRatingDistribution[];
+    movements: RiskRatingMovement[];
+    /** Customers whose rating moves, rises before falls, biggest change first (at most 100). */
+    customers: RiskImpactCustomer[];
+}
+/**
+ * How the simple form fills the external ID: `MANUAL` (typed by the
+ * officer), `DOCUMENT` (`<type>.<country>.<number>` of the chosen ID document,
+ * or `REG.<country>.<registrationNumber>` for entities — deterministic),
+ * `NAME_HASH` (hash of the normalised name — deterministic), `RANDOM`.
+ */
+export type SimpleCustomerExternalIdStrategy = 'MANUAL' | 'DOCUMENT' | 'NAME_HASH' | 'RANDOM';
+/** Fields a simple entity registration type can show / require. */
+export type SimpleEntityFormField = 'registrationNumber' | 'taxId' | 'dateOfIncorporation' | 'tradingNames' | 'websites' | 'stakeholders';
+/** One entry of the simple form's ID-document selector. */
+export interface SimpleCustomerDocumentType {
+    id: string;
+    label: string;
+    /** Stored verbatim as the identification document `type`, e.g. `NATIONAL_ID`. */
+    type: string;
+    /** Issuing country, ISO 3166-1 alpha-3. The preselection when `countryEditable`. */
+    country: string;
+    /** Whether the officer may change the issuing country. */
+    countryEditable: boolean;
+}
+/** One entry of the simple Add Entity form's registration-type selector. */
+export interface SimpleEntityRegistrationType {
+    id: string;
+    label: string;
+    /** Stored verbatim as `Entity.entityType`; null leaves it unset. */
+    entityType?: string | null;
+    /** Country of incorporation, ISO 3166-1 alpha-3. */
+    country: string;
+    /** Fields displayed on this registration type's simple entity form. */
+    visibleFields: SimpleEntityFormField[];
+    /** Displayed fields that must be completed. */
+    requiredFields: SimpleEntityFormField[];
+}
+/** A named bundle of tags + standing assignment a new customer starts with (a line of business or intake channel). */
+export interface SimpleCustomerPreset {
+    id: string;
+    label: string;
+    tags: TagValue[];
+    assignedToUserIds: string[];
+    assignedToTeamIds: string[];
+}
+/** What the individual and entity simple forms have in common. */
+export interface SimpleCreationPreferencesBase {
+    /** Whether the create page offers the simple mode at all. */
+    enabled: boolean;
+    /** Whether the create page opens in simple mode. */
+    openByDefault: boolean;
+    externalIdStrategy: SimpleCustomerExternalIdStrategy;
+    presets: SimpleCustomerPreset[];
+    /** Preset preselected on the simple form; null = none. */
+    defaultPresetId?: string | null;
+    /** Whether the simple form insists on a preset being chosen (when any exist). */
+    requirePreset: boolean;
+    /** Whether the officer may change the tags a preset applied. */
+    allowTags: boolean;
+    /** Whether the officer may change the assignees a preset applied. */
+    allowAssignment: boolean;
+    /** Whether the creating officer is added to the new customer's assignees. */
+    assignCreator: boolean;
+}
+/** Creation setup of the simple Add Individual form. */
+export interface SimpleCustomerCreationPreferences extends SimpleCreationPreferencesBase {
+    documentTypes: SimpleCustomerDocumentType[];
+    defaultDocumentTypeId?: string | null;
+}
+/**
+ * Stakeholder capture on the simple Add Entity form. Each new stakeholder is
+ * created as an Individual customer (from one of `documentTypes`) and linked.
+ */
+export interface SimpleEntityStakeholderPreferences {
+    documentTypes: SimpleCustomerDocumentType[];
+    defaultDocumentTypeId?: string | null;
+    /** Whether the stakeholder row asks for an ownership percentage. */
+    collectOwnership: boolean;
+    collectNationality: boolean;
+    collectDateOfBirth: boolean;
+}
+/** Creation setup of the simple Add Entity form. */
+export interface SimpleEntityCreationPreferences extends SimpleCreationPreferencesBase {
+    registrationTypes: SimpleEntityRegistrationType[];
+    defaultRegistrationTypeId?: string | null;
+    stakeholders: SimpleEntityStakeholderPreferences;
+}
+export interface SimpleCustomerDocumentTypeInput {
+    /** Omit to let the server mint an id for a new entry. */
+    id?: string | null;
+    /** 1–80 characters. */
+    label: string;
+    /** 1–60 characters. */
+    type: string;
+    /** ISO 3166-1 alpha-3. */
+    country: string;
+    countryEditable?: boolean | null;
+}
+export interface SimpleEntityRegistrationTypeInput {
+    /** Omit to let the server mint an id for a new entry. */
+    id?: string | null;
+    /** 1–80 characters. */
+    label: string;
+    /** Max 80 characters. */
+    entityType?: string | null;
+    /** ISO 3166-1 alpha-3. */
+    country: string;
+    visibleFields?: SimpleEntityFormField[] | null;
+    requiredFields?: SimpleEntityFormField[] | null;
+}
+export interface SimpleCustomerPresetInput {
+    /** Omit to let the server mint an id for a new preset. */
+    id?: string | null;
+    /** 1–80 characters. */
+    label: string;
+    /** Must be in the `customer.tags` catalogue. */
+    tags: TagValueInput[];
+    assignedToUserIds: string[];
+    assignedToTeamIds: string[];
+}
+/** Fields shared by both simple-creation inputs. A write fully replaces the setup. */
+export interface UpdateSimpleCreationPreferencesBaseInput {
+    enabled: boolean;
+    openByDefault: boolean;
+    externalIdStrategy: SimpleCustomerExternalIdStrategy;
+    /** At most 50. */
+    presets: SimpleCustomerPresetInput[];
+    defaultPresetId?: string | null;
+    /** Defaults to false. */
+    requirePreset?: boolean | null;
+    allowTags: boolean;
+    allowAssignment: boolean;
+    /** Defaults to false. */
+    assignCreator?: boolean | null;
+}
+export interface UpdateSimpleCustomerCreationPreferencesInput extends UpdateSimpleCreationPreferencesBaseInput {
+    /** At most 50. */
+    documentTypes: SimpleCustomerDocumentTypeInput[];
+    defaultDocumentTypeId?: string | null;
+}
+export interface SimpleEntityStakeholderPreferencesInput {
+    /** At most 50. */
+    documentTypes: SimpleCustomerDocumentTypeInput[];
+    defaultDocumentTypeId?: string | null;
+    collectOwnership: boolean;
+    collectNationality: boolean;
+    collectDateOfBirth: boolean;
+}
+export interface UpdateSimpleEntityCreationPreferencesInput extends UpdateSimpleCreationPreferencesBaseInput {
+    /** At most 50. */
+    registrationTypes: SimpleEntityRegistrationTypeInput[];
+    defaultRegistrationTypeId?: string | null;
+    /** Omitted = the defaults. */
+    stakeholders?: SimpleEntityStakeholderPreferencesInput | null;
+}
 //# sourceMappingURL=types.d.ts.map