@arkyc/types 1.2.11 → 2.1.0

package/dist/sdk.d.mts

@@ -1,10 +1,9 @@
 import { Metadata } from "./common.mjs";
 import { VerificationDecision, VerificationStatus } from "./verification.mjs";
 import { ExtractedData } from "./access.mjs";
-
 //#region src/sdk.d.ts
 /** Options for constructing the server SDK client (`new Arkyc(...)`). */
-interface SdkOptions {
+export interface SdkOptions {
   /** Project secret key, e.g. `sk_live_…`. */
   secretKey: string;
   /** API base URL; defaults to the hosted Arkyc API. */
@@ -13,14 +12,14 @@ interface SdkOptions {
   timeoutMs?: number;
 }
 /** Parameters for creating a verification session from a backend. */
-interface CreateSessionParams {
+export interface CreateSessionParams {
   userReference?: string;
   metadata?: Metadata;
   /** Optional override for how long the session/client token stays valid. */
   expiresInSeconds?: number;
 }
 /** The session representation returned by the SDK/public API. */
-interface SessionResource {
+export interface SessionResource {
   id: string;
   status: VerificationStatus;
   user_reference: string | null;
@@ -33,5 +32,4 @@ interface SessionResource {
   created_at: string;
 }
 //#endregion
-export { CreateSessionParams, SdkOptions, SessionResource };
 //# sourceMappingURL=sdk.d.mts.map

package/dist/sdk.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.d.mts","names":[],"sources":["../src/sdk.ts"],"mappings":";;;;;;UAKiB,UAAA;EAAA;EAEf,SAAA;;EAEA,OAAA;EAFA;EAIA,SAAA;AAAA;;UAIe,mBAAA;EACf,aAAA;EACA,QAAA,GAAW,QAAQ;;EAEnB,gBAAA;AAAA;;UAIe,eAAA;EACf,EAAA;EACA,MAAA,EAAQ,kBAAA;EACR,cAAA;EACA,QAAA,EAAU,oBAAA;EAJoB;EAM9B,YAAA;EAJQ;EAMR,SAAA,GAAY,aAAA;EACZ,UAAA;EACA,UAAA;AAAA"}
+{"version":3,"file":"sdk.d.mts","names":[],"sources":["../src/sdk.ts"],"mappings":";;;;;iBAKiB;;EAEf;;EAEA;;EAEA;;;iBAIe;EACf;EACA,WAAW;;EAEX;;;iBAIe;EACf;EACA,QAAQ;EACR;EACA,UAAU;;EAEV;;EAEA,YAAY;EACZ;EACA"}

package/dist/settings.d.mts

@@ -1,36 +1,24 @@
 import { Entity } from "./common.mjs";
-
 //#region src/settings.d.ts
-/**
- * Realtime transport for verification events (Phase 16). `pusher` covers both
- * hosted Pusher Channels (default, via a cluster) and self-hosted soketi (opt-in,
- * via a host) — they share the Pusher protocol. `polling` carries no push
- * transport: clients poll the session endpoint instead (a universal fallback that
- * needs no infrastructure). `off` disables live updates entirely.
- */
-type RealtimeTransport = 'pusher' | 'firebase' | 'polling' | 'off';
 /**
  * Which capture/liveness flow the widget offers (Phase 17). `passive` = the
  * current selfie flow; `active` = guided active-liveness challenges; `both` =
  * offer active, falling back to passive on failure/unsupported devices.
  */
-type CaptureModel = 'passive' | 'active' | 'both';
+export type CaptureModel = 'passive' | 'active' | 'both';
 /**
  * Platform-wide settings, managed by platform admins on the `/admin` surface and
  * read by the app at runtime. A single typed record (see {@link GlobalSetting}),
  * always merged over {@link DEFAULT_GLOBAL_SETTINGS} so every key is present.
  */
-interface GlobalSettings {
+export interface GlobalSettings {
   /** Branding/basics for the whole platform. */
   platform: {
     name: string;
-    support_email: string | null; /** Whether new organization sign-ups are accepted. */
+    support_email: string | null;
+    /** Whether new organization sign-ups are accepted. */
     signups_enabled: boolean;
   };
-  /** Realtime delivery configuration (consumed in Phase 16). */
-  realtime: {
-    transport: RealtimeTransport;
-  };
   /** Default capture/liveness flow offered to widgets (Phase 17). */
   capture: {
     model: CaptureModel;
@@ -46,11 +34,10 @@ interface GlobalSettings {
   };
 }
 /** The persisted singleton row backing {@link GlobalSettings}. */
-interface GlobalSetting extends Entity {
+export interface GlobalSetting extends Entity {
   settings: GlobalSettings;
 }
 /** Defaults applied when a settings key is unset. */
-declare const DEFAULT_GLOBAL_SETTINGS: GlobalSettings;
+export declare const DEFAULT_GLOBAL_SETTINGS: GlobalSettings;
 //#endregion
-export { CaptureModel, DEFAULT_GLOBAL_SETTINGS, GlobalSetting, GlobalSettings, RealtimeTransport };
 //# sourceMappingURL=settings.d.mts.map

package/dist/settings.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"settings.d.mts","names":[],"sources":["../src/settings.ts"],"mappings":";;;;;AASA;;;;AAA6B;KAAjB,iBAAA;;;;AAOY;AAOxB;KAPY,YAAA;;;;;;UAOK,cAAA;EASf;EAPA,QAAA;IACE,IAAA;IACA,aAAA,iBAUA;IARA,eAAA;EAAA;EAiBA;EAdF,QAAA;IACE,SAAA,EAAW,iBAAA;EAAA;EAkBgB;EAf7B,OAAA;IACE,KAAA,EAAO,YAAY;EAAA;EAerB;EAZA,MAAA;IAYwB;AAAA;AAI1B;;;IAVI,eAAA;EAAA;AAAA;;UAKa,aAAA,SAAsB,MAAM;EAC3C,QAAA,EAAU,cAAA;AAAA;;cAIC,uBAAA,EAAyB,cAerC"}
+{"version":3,"file":"settings.d.mts","names":[],"sources":["../src/settings.ts"],"mappings":";;;;;;;YAOY;;;;;;iBAOK;;EAEf;IACE;IACA;;IAEA;;;EAGF;IACE,OAAO;;;EAGT;;;;;;IAME;;;;iBAKa,sBAAsB;EACrC,UAAU;;;qBAIC,yBAAyB"}

package/dist/settings.mjs

@@ -6,7 +6,6 @@ const DEFAULT_GLOBAL_SETTINGS = {
 		support_email: null,
 		signups_enabled: true
 	},
-	realtime: { transport: "off" },
 	capture: { model: "passive" },
 	assets: { url_ttl_seconds: 1800 }
 };

package/dist/settings.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"settings.mjs","names":[],"sources":["../src/settings.ts"],"sourcesContent":["import type { Entity } from './common'\n\n/**\n * Realtime transport for verification events (Phase 16). `pusher` covers both\n * hosted Pusher Channels (default, via a cluster) and self-hosted soketi (opt-in,\n * via a host) — they share the Pusher protocol. `polling` carries no push\n * transport: clients poll the session endpoint instead (a universal fallback that\n * needs no infrastructure). `off` disables live updates entirely.\n */\nexport type RealtimeTransport = 'pusher' | 'firebase' | 'polling' | 'off'\n\n/**\n * Which capture/liveness flow the widget offers (Phase 17). `passive` = the\n * current selfie flow; `active` = guided active-liveness challenges; `both` =\n * offer active, falling back to passive on failure/unsupported devices.\n */\nexport type CaptureModel = 'passive' | 'active' | 'both'\n\n/**\n * Platform-wide settings, managed by platform admins on the `/admin` surface and\n * read by the app at runtime. A single typed record (see {@link GlobalSetting}),\n * always merged over {@link DEFAULT_GLOBAL_SETTINGS} so every key is present.\n */\nexport interface GlobalSettings {\n  /** Branding/basics for the whole platform. */\n  platform: {\n    name: string\n    support_email: string | null\n    /** Whether new organization sign-ups are accepted. */\n    signups_enabled: boolean\n  }\n  /** Realtime delivery configuration (consumed in Phase 16). */\n  realtime: {\n    transport: RealtimeTransport\n  }\n  /** Default capture/liveness flow offered to widgets (Phase 17). */\n  capture: {\n    model: CaptureModel\n  }\n  /** Signed session-asset links (captured document/selfie images). */\n  assets: {\n    /**\n     * How long a signed asset URL stays valid, in seconds. The link embeds its\n     * own expiry, so a change only affects newly minted URLs; existing links\n     * keep their original window. Bounded to [60, 86400] (1 minute to 24 hours).\n     */\n    url_ttl_seconds: number\n  }\n}\n\n/** The persisted singleton row backing {@link GlobalSettings}. */\nexport interface GlobalSetting extends Entity {\n  settings: GlobalSettings\n}\n\n/** Defaults applied when a settings key is unset. */\nexport const DEFAULT_GLOBAL_SETTINGS: GlobalSettings = {\n  platform: {\n    name: 'Arkyc',\n    support_email: null,\n    signups_enabled: true,\n  },\n  realtime: {\n    transport: 'off',\n  },\n  capture: {\n    model: 'passive',\n  },\n  assets: {\n    url_ttl_seconds: 1800,\n  },\n}\n"],"mappings":";;AAwDA,MAAa,0BAA0C;CACrD,UAAU;EACR,MAAM;EACN,eAAe;EACf,iBAAiB;CACnB;CACA,UAAU,EACR,WAAW,MACb;CACA,SAAS,EACP,OAAO,UACT;CACA,QAAQ,EACN,iBAAiB,KACnB;AACF"}
+{"version":3,"file":"settings.mjs","names":[],"sources":["../src/settings.ts"],"sourcesContent":["import type { Entity } from './common'\n\n/**\n * Which capture/liveness flow the widget offers (Phase 17). `passive` = the\n * current selfie flow; `active` = guided active-liveness challenges; `both` =\n * offer active, falling back to passive on failure/unsupported devices.\n */\nexport type CaptureModel = 'passive' | 'active' | 'both'\n\n/**\n * Platform-wide settings, managed by platform admins on the `/admin` surface and\n * read by the app at runtime. A single typed record (see {@link GlobalSetting}),\n * always merged over {@link DEFAULT_GLOBAL_SETTINGS} so every key is present.\n */\nexport interface GlobalSettings {\n  /** Branding/basics for the whole platform. */\n  platform: {\n    name: string\n    support_email: string | null\n    /** Whether new organization sign-ups are accepted. */\n    signups_enabled: boolean\n  }\n  /** Default capture/liveness flow offered to widgets (Phase 17). */\n  capture: {\n    model: CaptureModel\n  }\n  /** Signed session-asset links (captured document/selfie images). */\n  assets: {\n    /**\n     * How long a signed asset URL stays valid, in seconds. The link embeds its\n     * own expiry, so a change only affects newly minted URLs; existing links\n     * keep their original window. Bounded to [60, 86400] (1 minute to 24 hours).\n     */\n    url_ttl_seconds: number\n  }\n}\n\n/** The persisted singleton row backing {@link GlobalSettings}. */\nexport interface GlobalSetting extends Entity {\n  settings: GlobalSettings\n}\n\n/** Defaults applied when a settings key is unset. */\nexport const DEFAULT_GLOBAL_SETTINGS: GlobalSettings = {\n  platform: {\n    name: 'Arkyc',\n    support_email: null,\n    signups_enabled: true,\n  },\n  capture: {\n    model: 'passive',\n  },\n  assets: {\n    url_ttl_seconds: 1800,\n  },\n}\n"],"mappings":";;AA2CA,MAAa,0BAA0C;CACrD,UAAU;EACR,MAAM;EACN,eAAe;EACf,iBAAiB;CACnB;CACA,SAAS,EACP,OAAO,UACT;CACA,QAAQ,EACN,iBAAiB,KACnB;AACF"}

package/dist/user.d.mts

@@ -1,8 +1,7 @@
 import { Entity, IsoDateTime } from "./common.mjs";
-
 //#region src/user.d.ts
 /** A platform user account. Users belong to one or more organizations via membership. */
-interface User extends Entity {
+export interface User extends Entity {
   name: string;
   email: string;
   /** Never serialised to clients; present on the DB row only. */
@@ -11,7 +10,6 @@ interface User extends Entity {
   last_login_at: IsoDateTime | null;
 }
 /** A user shape safe to expose to clients (no credential material). */
-type PublicUser = Omit<User, 'password_hash'>;
+export type PublicUser = Omit<User, 'password_hash'>;
 //#endregion
-export { PublicUser, User };
 //# sourceMappingURL=user.d.mts.map

package/dist/user.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"user.d.mts","names":[],"sources":["../src/user.ts"],"mappings":";;;;UAGiB,IAAA,SAAa,MAAM;EAClC,IAAA;EACA,KAAA;;EAEA,aAAA;EACA,UAAA;EACA,aAAA,EAAe,WAAA;AAAA;;KAIL,UAAA,GAAa,IAAI,CAAC,IAAA"}
+{"version":3,"file":"user.d.mts","names":[],"sources":["../src/user.ts"],"mappings":";;;iBAGiB,aAAa;EAC5B;EACA;;EAEA;EACA;EACA,eAAe;;;YAIL,aAAa,KAAK"}

package/dist/verification.d.mts

@@ -1,26 +1,25 @@
 import { Entity, Id, IsoDateTime, Metadata, ProjectScoped } from "./common.mjs";
-
 //#region src/verification.d.ts
 /** The lifecycle state of a verification session. */
-type VerificationStatus = 'pending' | 'started' | 'document_submitted' | 'address_submitted' | 'liveness_submitted' | 'processing' | 'requires_review' | 'approved' | 'rejected' | 'expired' | 'cancelled';
+export type VerificationStatus = 'pending' | 'started' | 'document_submitted' | 'address_submitted' | 'liveness_submitted' | 'processing' | 'requires_review' | 'approved' | 'rejected' | 'expired' | 'cancelled';
 /** The outcome of the decision engine (or a manual review). */
-type VerificationDecision = 'approved' | 'requires_review' | 'rejected';
+export type VerificationDecision = 'approved' | 'requires_review' | 'rejected';
 /** Whether liveness is checked passively (a selfie) or actively (a challenge video). */
-type LivenessMode = 'passive' | 'active';
+export type LivenessMode = 'passive' | 'active';
 /**
  * A single active-liveness challenge the user is prompted to perform. The server
  * issues a randomized sequence per session; the widget records the user doing
  * them and submits the sequence it performed for the driver to validate.
  */
-type LivenessChallenge = 'turn_left' | 'turn_right' | 'blink' | 'smile' | 'nod' | 'move_closer';
+export type LivenessChallenge = 'turn_left' | 'turn_right' | 'blink' | 'smile' | 'nod' | 'move_closer';
 /** Why a session reached its decision. */
-type DecisionReason = 'AUTO_APPROVED' | 'LOW_DOCUMENT_QUALITY' | 'OCR_LOW_CONFIDENCE' | 'DOCUMENT_EXPIRED' | 'LIVENESS_FAILED' | 'LIVENESS_LOW_CONFIDENCE' | 'FACE_MATCH_FAILED' | 'FACE_MATCH_LOW_CONFIDENCE' | 'MULTIPLE_FACES_DETECTED' | 'ADDRESS_VERIFICATION_FAILED' | 'ADDRESS_LOW_CONFIDENCE' | 'MANUAL_APPROVAL' | 'MANUAL_REJECTION' | 'RETRY_REQUESTED';
+export type DecisionReason = 'AUTO_APPROVED' | 'LOW_DOCUMENT_QUALITY' | 'OCR_LOW_CONFIDENCE' | 'DOCUMENT_EXPIRED' | 'LIVENESS_FAILED' | 'LIVENESS_LOW_CONFIDENCE' | 'FACE_MATCH_FAILED' | 'FACE_MATCH_LOW_CONFIDENCE' | 'MULTIPLE_FACES_DETECTED' | 'ADDRESS_VERIFICATION_FAILED' | 'ADDRESS_LOW_CONFIDENCE' | 'MANUAL_APPROVAL' | 'MANUAL_REJECTION' | 'RETRY_REQUESTED' | 'DUPLICATE_DOCUMENT' | 'DUPLICATE_IDENTITY' | 'DUPLICATE_FACE' | 'DOCUMENT_TAMPERING' | 'SANCTIONS_MATCH' | 'PEP_MATCH' | 'ADVERSE_MEDIA_MATCH' | 'HIGH_RISK_DEVICE' | 'VELOCITY_EXCEEDED' | 'UNDERAGE';
 /**
  * A verification session: the full lifecycle of one verification flow, owned by
  * a project (and organization). Created from an integrator's backend, driven by the
  * widget, decided automatically and/or by a human reviewer.
  */
-interface VerificationSession extends Entity, ProjectScoped {
+export interface VerificationSession extends Entity, ProjectScoped {
   /** Integrator's own reference for the end user being verified. */
   user_reference: string | null;
   /** Person's name extracted from the document (OCR), when available. */
@@ -40,5 +39,4 @@ interface VerificationSession extends Entity, ProjectScoped {
   metadata: Metadata;
 }
 //#endregion
-export { DecisionReason, LivenessChallenge, LivenessMode, VerificationDecision, VerificationSession, VerificationStatus };
 //# sourceMappingURL=verification.d.mts.map

package/dist/verification.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"verification.d.mts","names":[],"sources":["../src/verification.ts"],"mappings":";;;;KAGY,kBAAA;AAAZ;AAAA,KAcY,oBAAA;;KAGA,YAAA;AAjBkB;AAc9B;;;;AAd8B,KAwBlB,iBAAA;AAPZ;AAAA,KAUY,cAAA;;;AAVY;AAOxB;;UAwBiB,mBAAA,SAA4B,MAAA,EAAQ,aAAA;EAxBxB;EA0B3B,cAAA;EAvBU;EAyBV,IAAA;EACA,MAAA,EAAQ,kBAAA;EACR,aAAA,EAAe,oBAAA;EACf,cAAA,EAAgB,oBAAA;EAChB,eAAA,EAAiB,cAAA;EARkB;EAUnC,UAAA;EALQ;EAOR,iBAAA;EACA,UAAA,EAAY,WAAA;EACZ,YAAA,EAAc,WAAA;EACd,WAAA,EAAa,WAAA;EACb,WAAA,EAAa,EAAA;EACb,QAAA,EAAU,QAAA;AAAA"}
+{"version":3,"file":"verification.d.mts","names":[],"sources":["../src/verification.ts"],"mappings":";;;YAGY;;YAcA;;YAGA;;;;;;YAOA;;YAGA;;;;;;iBA+BK,4BAA4B,QAAQ;;EAEnD;;EAEA;EACA,QAAQ;EACR,eAAe;EACf,gBAAgB;EAChB,iBAAiB;;EAEjB;;EAEA;EACA,YAAY;EACZ,cAAc;EACd,aAAa;EACb,aAAa;EACb,UAAU"}

package/dist/webhook.d.mts

@@ -1,15 +1,16 @@
 import { Entity, Id, IsoDateTime, ProjectScoped } from "./common.mjs";
 import { DecisionReason, VerificationStatus } from "./verification.mjs";
-
+import { ScreeningHit, WebhookRiskCheck } from "./risk.mjs";
 //#region src/webhook.d.ts
 /** The set of webhook event names Arkyc can deliver. */
-type WebhookEventName = 'verification.started' | 'verification.document_submitted' | 'verification.address_submitted' | 'verification.processing' | 'verification.requires_review' | 'verification.approved' | 'verification.rejected' | 'verification.completed' | 'verification.expired' | 'verification.cancelled';
+export type WebhookEventName = 'verification.started' | 'verification.document_submitted' | 'verification.address_submitted' | 'verification.processing' | 'verification.requires_review' | 'verification.approved' | 'verification.rejected' | 'verification.completed' | 'verification.expired' | 'verification.cancelled' | 'verification.screening_alert';
 /** Per-check summary included in a webhook payload. */
-interface WebhookChecks {
+export interface WebhookChecks {
   document?: {
     quality_score: number;
     ocr_confidence: number;
-    expired: boolean; /** Which parser produced the OCR fields: the MRZ, a custom parser, or the generic scraper. */
+    expired: boolean;
+    /** Which parser produced the OCR fields: the MRZ, a custom parser, or the generic scraper. */
     ocr_parse_stage?: 'mrz' | 'custom' | 'generic';
   };
   liveness?: {
@@ -22,12 +23,19 @@ interface WebhookChecks {
   };
   address?: {
     passed: boolean;
-    score: number; /** Which corroboration methods ran. */
+    score: number;
+    /** Which corroboration methods ran. */
     methods: string[];
   };
+  /** Risk signals raised against the session and the aggregate score. */
+  risk?: WebhookRiskCheck;
+  /** Watchlist screening, when the workflow runs it. */
+  screening?: {
+    hits: ScreeningHit[];
+  };
 }
 /** The JSON body delivered to a webhook endpoint. */
-interface WebhookEvent {
+export interface WebhookEvent {
   event: WebhookEventName;
   session_id: Id;
   organization_id: Id;
@@ -41,9 +49,9 @@ interface WebhookEvent {
   created_at: IsoDateTime;
 }
 /** Webhook endpoint lifecycle status. */
-type WebhookEndpointStatus = 'active' | 'disabled';
+export type WebhookEndpointStatus = 'active' | 'disabled';
 /** A configured webhook endpoint for a project. */
-interface WebhookEndpoint extends Entity, ProjectScoped {
+export interface WebhookEndpoint extends Entity, ProjectScoped {
   url: string;
   /** Hash of the signing secret; the raw secret is shown once at creation. */
   secret_hash: string;
@@ -51,9 +59,9 @@ interface WebhookEndpoint extends Entity, ProjectScoped {
   status: WebhookEndpointStatus;
 }
 /** Delivery attempt state for a webhook. */
-type WebhookDeliveryStatus = 'pending' | 'delivered' | 'failed';
+export type WebhookDeliveryStatus = 'pending' | 'delivered' | 'failed';
 /** A record of a webhook delivery (and its retries). */
-interface WebhookDelivery extends Entity, ProjectScoped {
+export interface WebhookDelivery extends Entity, ProjectScoped {
   webhook_endpoint_id: Id;
   event: WebhookEventName;
   payload: WebhookEvent;
@@ -64,5 +72,4 @@ interface WebhookDelivery extends Entity, ProjectScoped {
   next_retry_at: IsoDateTime | null;
 }
 //#endregion
-export { WebhookChecks, WebhookDelivery, WebhookDeliveryStatus, WebhookEndpoint, WebhookEndpointStatus, WebhookEvent, WebhookEventName };
 //# sourceMappingURL=webhook.d.mts.map

package/dist/webhook.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"webhook.d.mts","names":[],"sources":["../src/webhook.ts"],"mappings":";;;;;KAIY,gBAAA;AAAZ;AAAA,UAaiB,aAAA;EACf,QAAA;IACE,aAAA;IACA,cAAA;IACA,OAAA,WAJ0B;IAM1B,eAAA;EAAA;EAEF,QAAA;IACE,MAAA;IACA,KAAA;EAAA;EAEF,UAAA;IACE,MAAA;IACA,gBAAA;EAAA;EAEF,OAAA;IACE,MAAA;IACA,KAAA,UAFF;IAIE,OAAA;EAAA;AAAA;;UAKa,YAAA;EACf,KAAA,EAAO,gBAAA;EACP,UAAA,EAAY,EAAA;EACZ,eAAA,EAAiB,EAAA;EACjB,UAAA,EAAY,EAAA;EACZ,cAAA;EACA,MAAA,EAAQ,kBAAA;EACR,MAAA,EAAQ,aAAA;EACR,eAAA,EAAiB,cAAA;EADT;EAGR,MAAA,EAAQ,MAAA;EACR,UAAA,EAAY,WAAA;AAAA;;KAIF,qBAAA;;UAGK,eAAA,SAAwB,MAAA,EAAQ,aAAA;EAC/C,GAAA;EAjBY;EAmBZ,WAAA;EACA,MAAA,EAAQ,gBAAA;EACR,MAAA,EAAQ,qBAAA;AAAA;;KAIE,qBAAA;;UAGK,eAAA,SAAwB,MAAA,EAAQ,aAAA;EAC/C,mBAAA,EAAqB,EAAA;EACrB,KAAA,EAAO,gBAAA;EACP,OAAA,EAAS,YAAA;EACT,MAAA,EAAQ,qBAAA;EACR,eAAA;EACA,aAAA;EACA,QAAA;EACA,aAAA,EAAe,WAAA;AAAA"}
+{"version":3,"file":"webhook.d.mts","names":[],"sources":["../src/webhook.ts"],"mappings":";;;;;YAKY;;iBAcK;EACf;IACE;IACA;IACA;;IAEA;;EAEF;IACE;IACA;;EAEF;IACE;IACA;;EAEF;IACE;IACA;;IAEA;;;EAGF,OAAO;;EAEP;IACE,MAAM;;;;iBAKO;EACf,OAAO;EACP,YAAY;EACZ,iBAAiB;EACjB,YAAY;EACZ;EACA,QAAQ;EACR,QAAQ;EACR,iBAAiB;;EAEjB,QAAQ;EACR,YAAY;;;YAIF;;iBAGK,wBAAwB,QAAQ;EAC/C;;EAEA;EACA,QAAQ;EACR,QAAQ;;;YAIE;;iBAGK,wBAAwB,QAAQ;EAC/C,qBAAqB;EACrB,OAAO;EACP,SAAS;EACT,QAAQ;EACR;EACA;EACA;EACA,eAAe"}

package/dist/widget.d.mts

@@ -1,18 +1,17 @@
 import { VerificationDecision, VerificationStatus } from "./verification.mjs";
 import { ProjectBranding } from "./project.mjs";
-
 //#region src/widget.d.ts
 /** How the widget mounts into the host page. */
-type WidgetMode = 'overlay' | 'inline' | 'hosted';
+export type WidgetMode = 'overlay' | 'inline' | 'hosted';
 /** The screens of the widget verification flow, in order. */
-type WidgetStep = 'welcome' | 'document_selection' | 'front_capture' | 'back_capture' | 'ocr_processing' | 'address_entry' | 'address_processing' | 'active_liveness' | 'selfie_capture' | 'passive_liveness' | 'face_match' | 'processing' | 'result';
+export type WidgetStep = 'welcome' | 'document_selection' | 'front_capture' | 'back_capture' | 'ocr_processing' | 'address_entry' | 'address_processing' | 'active_liveness' | 'selfie_capture' | 'passive_liveness' | 'face_match' | 'processing' | 'result';
 /** The result handed to the widget's `onComplete` callback. */
-interface WidgetResult {
+export interface WidgetResult {
   status: VerificationStatus;
   decision: VerificationDecision | null;
 }
 /** Options for launching/mounting the embeddable widget. */
-interface WidgetOptions {
+export interface WidgetOptions {
   /** Short-lived client token minted by the backend for this session. */
   token: string;
   mode?: WidgetMode;
@@ -25,5 +24,4 @@ interface WidgetOptions {
   onClose?: () => void;
 }
 //#endregion
-export { WidgetMode, WidgetOptions, WidgetResult, WidgetStep };
 //# sourceMappingURL=widget.d.mts.map

package/dist/widget.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"widget.d.mts","names":[],"sources":["../src/widget.ts"],"mappings":";;;;;KAIY,UAAA;AAAZ;AAAA,KAGY,UAAA;;UAgBK,YAAA;EACf,MAAA,EAAQ,kBAAA;EACR,QAAA,EAAU,oBAAoB;AAAA;;UAIf,aAAA;EAtBK;EAwBpB,KAAA;EACA,IAAA,GAAO,UAAA;;EAEP,SAAA,YAAqB,WAAA;EACrB,QAAA,GAAW,eAAA;EACX,OAAA;EACA,UAAA,IAAc,MAAA,EAAQ,YAAA;EACtB,OAAA,IAAW,KAAA,EAAO,KAAA;EAClB,OAAA;AAAA"}
+{"version":3,"file":"widget.d.mts","names":[],"sources":["../src/widget.ts"],"mappings":";;;;YAIY;;YAGA;;iBAgBK;EACf,QAAQ;EACR,UAAU;;;iBAIK;;EAEf;EACA,OAAO;;EAEP,qBAAqB;EACrB,WAAW;EACX;EACA,cAAc,QAAQ;EACtB,WAAW,OAAO;EAClB"}

package/dist/workflow.d.mts

@@ -1,5 +1,5 @@
 import { Id, IsoDateTime } from "./common.mjs";
-
+import { RiskPolicyConfig, ScreeningStepConfig } from "./risk.mjs";
 //#region src/workflow.d.ts
 /**
  * Workflows (Phase 19).
@@ -12,27 +12,27 @@ import { Id, IsoDateTime } from "./common.mjs";
  * disturbs sessions already in flight.
  */
 /** A coarse verification stage a workflow can order and toggle. */
-type WorkflowStepKey = 'document' | 'address' | 'liveness' | 'face_match';
+export type WorkflowStepKey = 'document' | 'screening' | 'address' | 'liveness' | 'face_match';
 /**
  * The default pipeline's stages, in canonical order — what runs when a session
  * has no workflow. `address` is deliberately NOT here: it's an opt-in stage,
  * available only on custom workflows.
  */
-declare const WORKFLOW_STEP_KEYS: readonly WorkflowStepKey[];
+export declare const WORKFLOW_STEP_KEYS: readonly WorkflowStepKey[];
 /**
  * Every stage a custom workflow may include, in canonical order. Used by the
  * workflow editor and to validate/normalise stored steps — a superset of
- * {@link WORKFLOW_STEP_KEYS} that adds the opt-in `address` stage.
+ * {@link WORKFLOW_STEP_KEYS} that adds the opt-in `screening` and `address` stages.
  */
-declare const AVAILABLE_WORKFLOW_STEP_KEYS: readonly WorkflowStepKey[];
+export declare const AVAILABLE_WORKFLOW_STEP_KEYS: readonly WorkflowStepKey[];
 /** A method the address stage uses to corroborate the user's address. */
-type AddressMethod = 'poa_document' | 'device_location' | 'geocode_lookup';
+export type AddressMethod = 'poa_document' | 'device_location' | 'geocode_lookup';
 /** Every selectable address-verification method, in display order. */
-declare const ADDRESS_METHODS: readonly AddressMethod[];
+export declare const ADDRESS_METHODS: readonly AddressMethod[];
 /** What a failed/low-confidence address result does to the session. */
-type AddressOnFail = 'review' | 'reject';
+export type AddressOnFail = 'review' | 'reject';
 /** Configuration for the `address` stage, carried on its {@link WorkflowStep}. */
-interface AddressStepConfig {
+export interface AddressStepConfig {
   /** Methods to run; at least one when the stage is enabled. */
   methods: AddressMethod[];
   /**
@@ -48,30 +48,34 @@ interface AddressStepConfig {
   auto_approve_threshold?: number;
 }
 /** The default address config applied when the stage is enabled without one. */
-declare const DEFAULT_ADDRESS_CONFIG: AddressStepConfig;
+export declare const DEFAULT_ADDRESS_CONFIG: AddressStepConfig;
 /** One stage within a workflow, in pipeline order, on or off. */
-interface WorkflowStep {
+export interface WorkflowStep {
   key: WorkflowStepKey;
   enabled: boolean;
-  /** Stage-specific configuration. Only the `address` stage uses this today. */
-  config?: AddressStepConfig;
+  /** Stage-specific configuration, used by the `address` and `screening` stages. */
+  config?: AddressStepConfig | ScreeningStepConfig;
 }
 /** Workflow-wide toggles. */
-interface WorkflowOptions {
+export interface WorkflowOptions {
   /**
    * Skip OCR parsing — capture the document image but don't extract fields.
    * Useful when Arkyc is only used for data capture and the assets are handed
    * to a third party. Disables the document portrait too, so face match can't run.
    */
   skip_ocr: boolean;
+  /** Minimum age in years, from the extracted date of birth (`UNDERAGE`). */
+  min_age?: number;
+  /** How each risk signal affects the decision. Unlisted signals route to review. */
+  risk_policy?: RiskPolicyConfig;
 }
 /** The portable config of a workflow: ordered stages + options. */
-interface WorkflowConfig {
+export interface WorkflowConfig {
   steps: WorkflowStep[];
   options: WorkflowOptions;
 }
 /** A saved, organization-scoped workflow. */
-interface Workflow extends WorkflowConfig {
+export interface Workflow extends WorkflowConfig {
   id: Id;
   organization_id: Id;
   name: string;
@@ -79,22 +83,26 @@ interface Workflow extends WorkflowConfig {
   updated_at: IsoDateTime;
 }
 /** The default pipeline applied when a session has no workflow. */
-declare const DEFAULT_WORKFLOW_CONFIG: WorkflowConfig;
+export declare const DEFAULT_WORKFLOW_CONFIG: WorkflowConfig;
 /**
  * Whether a stage runs under a config. A `null` config means "no workflow" — the
  * default pipeline, where every stage runs. Within a real config, a stage that is
  * absent or `enabled: false` does not run.
  */
-declare function workflowEnables(config: WorkflowConfig | null | undefined, key: WorkflowStepKey): boolean;
+export declare function workflowEnables(config: WorkflowConfig | null | undefined, key: WorkflowStepKey): boolean;
 /**
  * The resolved address config for a session's workflow, or `null` when the
  * address stage isn't enabled. Missing fields fall back to {@link DEFAULT_ADDRESS_CONFIG}.
  */
-declare function workflowAddressConfig(config: WorkflowConfig | null | undefined): AddressStepConfig | null;
+export declare function workflowAddressConfig(config: WorkflowConfig | null | undefined): AddressStepConfig | null;
+/**
+ * The resolved screening config for a session's workflow, or `null` when the
+ * screening stage isn't enabled. Screening needs OCR fields to screen.
+ */
+export declare function workflowScreeningConfig(config: WorkflowConfig | null | undefined): ScreeningStepConfig | null;
 /** Whether OCR parsing should run: the document stage is on and `skip_ocr` is off. */
-declare function workflowRunsOcr(config: WorkflowConfig | null | undefined): boolean;
+export declare function workflowRunsOcr(config: WorkflowConfig | null | undefined): boolean;
 /** The enabled stages in pipeline order (used by the widget to sequence its steps). */
-declare function workflowEnabledSteps(config: WorkflowConfig | null | undefined): WorkflowStepKey[];
+export declare function workflowEnabledSteps(config: WorkflowConfig | null | undefined): WorkflowStepKey[];
 //#endregion
-export { ADDRESS_METHODS, AVAILABLE_WORKFLOW_STEP_KEYS, AddressMethod, AddressOnFail, AddressStepConfig, DEFAULT_ADDRESS_CONFIG, DEFAULT_WORKFLOW_CONFIG, WORKFLOW_STEP_KEYS, Workflow, WorkflowConfig, WorkflowOptions, WorkflowStep, WorkflowStepKey, workflowAddressConfig, workflowEnabledSteps, workflowEnables, workflowRunsOcr };
 //# sourceMappingURL=workflow.d.mts.map

package/dist/workflow.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"workflow.d.mts","names":[],"sources":["../src/workflow.ts"],"mappings":";;;;;AAcA;;;;AAA2B;AAO3B;;;;KAPY,eAAA;AAcZ;;;;AAAmE;AAAnE,cAPa,kBAAA,WAA6B,eAAe;;;;AAehC;AAGzB;cAXa,4BAAA,WAAuC,eAAe;;KAQvD,aAAA;AAGwC;AAAA,cAAvC,eAAA,WAA0B,aAAa;;KAGxC,aAAA;;UAGK,iBAAA;EAAA;EAEf,OAAA,EAAS,aAAA;;;;;EAKT,OAAA,EAAS,aAAa;EAAb;;;AAMa;AAIxB;EAJE,sBAAA;AAAA;;cAIW,sBAAA,EAAwB,iBAGpC;AAGD;AAAA,UAAiB,YAAA;EACf,GAAA,EAAK,eAAA;EACL,OAAA;EADA;EAGA,MAAA,GAAS,iBAAiB;AAAA;;UAIX,eAAA;EAJW;AAAA;AAI5B;;;EAME,QAAQ;AAAA;AAIV;AAAA,UAAiB,cAAA;EACf,KAAA,EAAO,YAAA;EACP,OAAA,EAAS,eAAe;AAAA;;UAIT,QAAA,SAAiB,cAAA;EAChC,EAAA,EAAI,EAAA;EACJ,eAAA,EAAiB,EAAA;EACjB,IAAA;EACA,UAAA,EAAY,WAAA;EACZ,UAAA,EAAY,WAAA;AAAA;;cAID,uBAAA,EAAyB,cAOrC;;;;;;iBAOe,eAAA,CAAgB,MAAA,EAAQ,cAAA,qBAAmC,GAAA,EAAK,eAAe;;;;;iBAY/E,qBAAA,CAAsB,MAAA,EAAQ,cAAA,sBAAoC,iBAAiB;;iBASnF,eAAA,CAAgB,MAAyC,EAAjC,cAAc;;iBAOtC,oBAAA,CAAqB,MAAA,EAAQ,cAAA,sBAAoC,eAAe"}
+{"version":3,"file":"workflow.d.mts","names":[],"sources":["../src/workflow.ts"],"mappings":";;;;;;;;;;;;;;YAeY;;;;;;qBAOC,6BAA6B;;;;;;qBAO7B,uCAAuC;;YASxC;;qBAGC,0BAA0B;;YAG3B;;iBAGK;;EAEf,SAAS;;;;;EAKT,SAAS;;;;;;EAMT;;;qBAIW,wBAAwB;;iBAMpB;EACf,KAAK;EACL;;EAEA,SAAS,oBAAoB;;;iBAId;;;;;;EAMf;;EAEA;;EAEA,cAAc;;;iBAIC;EACf,OAAO;EACP,SAAS;;;iBAIM,iBAAiB;EAChC,IAAI;EACJ,iBAAiB;EACjB;EACA,YAAY;EACZ,YAAY;;;qBAID,yBAAyB;;;;;;wBActB,gBAAgB,QAAQ,mCAAmC,KAAK;;;;;wBAYhE,sBAAsB,QAAQ,oCAAoC;;;;;wBAYlE,wBAAwB,QAAQ,oCAAoC;;wBASpE,gBAAgB,QAAQ;;wBAOxB,qBAAqB,QAAQ,oCAAoC"}

package/dist/workflow.mjs

@@ -1,3 +1,4 @@
+import { DEFAULT_SCREENING_CONFIG } from "./risk.mjs";
 //#region src/workflow.ts
 /**
 * The default pipeline's stages, in canonical order — what runs when a session
@@ -12,10 +13,11 @@ const WORKFLOW_STEP_KEYS = [
 /**
 * Every stage a custom workflow may include, in canonical order. Used by the
 * workflow editor and to validate/normalise stored steps — a superset of
-* {@link WORKFLOW_STEP_KEYS} that adds the opt-in `address` stage.
+* {@link WORKFLOW_STEP_KEYS} that adds the opt-in `screening` and `address` stages.
 */
 const AVAILABLE_WORKFLOW_STEP_KEYS = [
 	"document",
+	"screening",
 	"address",
 	"liveness",
 	"face_match"
@@ -71,6 +73,19 @@ function workflowAddressConfig(config) {
 		...step.config ?? {}
 	};
 }
+/**
+* The resolved screening config for a session's workflow, or `null` when the
+* screening stage isn't enabled. Screening needs OCR fields to screen.
+*/
+function workflowScreeningConfig(config) {
+	if (!config || !workflowRunsOcr(config)) return null;
+	const step = config.steps.find((s) => s.key === "screening" && s.enabled);
+	if (!step) return null;
+	return {
+		...DEFAULT_SCREENING_CONFIG,
+		...step.config ?? {}
+	};
+}
 /** Whether OCR parsing should run: the document stage is on and `skip_ocr` is off. */
 function workflowRunsOcr(config) {
 	if (!config) return true;
@@ -82,6 +97,6 @@ function workflowEnabledSteps(config) {
 	return config.steps.filter((step) => step.enabled).map((step) => step.key);
 }
 //#endregion
-export { ADDRESS_METHODS, AVAILABLE_WORKFLOW_STEP_KEYS, DEFAULT_ADDRESS_CONFIG, DEFAULT_WORKFLOW_CONFIG, WORKFLOW_STEP_KEYS, workflowAddressConfig, workflowEnabledSteps, workflowEnables, workflowRunsOcr };
+export { ADDRESS_METHODS, AVAILABLE_WORKFLOW_STEP_KEYS, DEFAULT_ADDRESS_CONFIG, DEFAULT_WORKFLOW_CONFIG, WORKFLOW_STEP_KEYS, workflowAddressConfig, workflowEnabledSteps, workflowEnables, workflowRunsOcr, workflowScreeningConfig };
 
 //# sourceMappingURL=workflow.mjs.map

package/dist/workflow.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"workflow.mjs","names":[],"sources":["../src/workflow.ts"],"sourcesContent":["import type { Id, IsoDateTime } from './common'\n\n/**\n * Workflows (Phase 19).\n *\n * An organization-scoped, reusable recipe that determines the order of the\n * coarse verification stages, lets each be turned off, and can skip OCR parsing\n * (capture-only). Workflows are optional: a session created without one runs the\n * default pipeline (document → liveness → face match, OCR on). A workflow's\n * config is snapshotted onto each session at creation, so editing it never\n * disturbs sessions already in flight.\n */\n\n/** A coarse verification stage a workflow can order and toggle. */\nexport type WorkflowStepKey = 'document' | 'address' | 'liveness' | 'face_match'\n\n/**\n * The default pipeline's stages, in canonical order — what runs when a session\n * has no workflow. `address` is deliberately NOT here: it's an opt-in stage,\n * available only on custom workflows.\n */\nexport const WORKFLOW_STEP_KEYS: readonly WorkflowStepKey[] = ['document', 'liveness', 'face_match']\n\n/**\n * Every stage a custom workflow may include, in canonical order. Used by the\n * workflow editor and to validate/normalise stored steps — a superset of\n * {@link WORKFLOW_STEP_KEYS} that adds the opt-in `address` stage.\n */\nexport const AVAILABLE_WORKFLOW_STEP_KEYS: readonly WorkflowStepKey[] = [\n  'document',\n  'address',\n  'liveness',\n  'face_match',\n]\n\n/** A method the address stage uses to corroborate the user's address. */\nexport type AddressMethod = 'poa_document' | 'device_location' | 'geocode_lookup'\n\n/** Every selectable address-verification method, in display order. */\nexport const ADDRESS_METHODS: readonly AddressMethod[] = ['poa_document', 'device_location', 'geocode_lookup']\n\n/** What a failed/low-confidence address result does to the session. */\nexport type AddressOnFail = 'review' | 'reject'\n\n/** Configuration for the `address` stage, carried on its {@link WorkflowStep}. */\nexport interface AddressStepConfig {\n  /** Methods to run; at least one when the stage is enabled. */\n  methods: AddressMethod[]\n  /**\n   * What a failed or low-confidence result does. `review` (default) flags the\n   * session for a human; `reject` fails it outright.\n   */\n  on_fail: AddressOnFail\n  /**\n   * Minimum address-verification confidence in [0, 1] to auto-verify the address.\n   * A passed address scoring below this is routed to manual review (the gate is\n   * never a rejection). Omitted falls back to the project `addressThreshold`.\n   */\n  auto_approve_threshold?: number\n}\n\n/** The default address config applied when the stage is enabled without one. */\nexport const DEFAULT_ADDRESS_CONFIG: AddressStepConfig = {\n  methods: ['geocode_lookup'],\n  on_fail: 'review',\n}\n\n/** One stage within a workflow, in pipeline order, on or off. */\nexport interface WorkflowStep {\n  key: WorkflowStepKey\n  enabled: boolean\n  /** Stage-specific configuration. Only the `address` stage uses this today. */\n  config?: AddressStepConfig\n}\n\n/** Workflow-wide toggles. */\nexport interface WorkflowOptions {\n  /**\n   * Skip OCR parsing — capture the document image but don't extract fields.\n   * Useful when Arkyc is only used for data capture and the assets are handed\n   * to a third party. Disables the document portrait too, so face match can't run.\n   */\n  skip_ocr: boolean\n}\n\n/** The portable config of a workflow: ordered stages + options. */\nexport interface WorkflowConfig {\n  steps: WorkflowStep[]\n  options: WorkflowOptions\n}\n\n/** A saved, organization-scoped workflow. */\nexport interface Workflow extends WorkflowConfig {\n  id: Id\n  organization_id: Id\n  name: string\n  created_at: IsoDateTime\n  updated_at: IsoDateTime\n}\n\n/** The default pipeline applied when a session has no workflow. */\nexport const DEFAULT_WORKFLOW_CONFIG: WorkflowConfig = {\n  steps: [\n    { key: 'document', enabled: true },\n    { key: 'liveness', enabled: true },\n    { key: 'face_match', enabled: true },\n  ],\n  options: { skip_ocr: false },\n}\n\n/**\n * Whether a stage runs under a config. A `null` config means \"no workflow\" — the\n * default pipeline, where every stage runs. Within a real config, a stage that is\n * absent or `enabled: false` does not run.\n */\nexport function workflowEnables(config: WorkflowConfig | null | undefined, key: WorkflowStepKey): boolean {\n  // No workflow runs the default pipeline only — opt-in stages (`address`) are\n  // off unless a custom workflow turns them on.\n  if (!config) return WORKFLOW_STEP_KEYS.includes(key)\n\n  return config.steps.some((step) => step.key === key && step.enabled)\n}\n\n/**\n * The resolved address config for a session's workflow, or `null` when the\n * address stage isn't enabled. Missing fields fall back to {@link DEFAULT_ADDRESS_CONFIG}.\n */\nexport function workflowAddressConfig(config: WorkflowConfig | null | undefined): AddressStepConfig | null {\n  if (!config) return null\n  const step = config.steps.find((s) => s.key === 'address' && s.enabled)\n  if (!step) return null\n\n  return { ...DEFAULT_ADDRESS_CONFIG, ...(step.config ?? {}) }\n}\n\n/** Whether OCR parsing should run: the document stage is on and `skip_ocr` is off. */\nexport function workflowRunsOcr(config: WorkflowConfig | null | undefined): boolean {\n  if (!config) return true\n\n  return workflowEnables(config, 'document') && !config.options.skip_ocr\n}\n\n/** The enabled stages in pipeline order (used by the widget to sequence its steps). */\nexport function workflowEnabledSteps(config: WorkflowConfig | null | undefined): WorkflowStepKey[] {\n  if (!config) return [...WORKFLOW_STEP_KEYS]\n\n  return config.steps.filter((step) => step.enabled).map((step) => step.key)\n}\n"],"mappings":";;;;;;AAqBA,MAAa,qBAAiD;CAAC;CAAY;CAAY;AAAY;;;;;;AAOnG,MAAa,+BAA2D;CACtE;CACA;CACA;CACA;AACF;;AAMA,MAAa,kBAA4C;CAAC;CAAgB;CAAmB;AAAgB;;AAuB7G,MAAa,yBAA4C;CACvD,SAAS,CAAC,gBAAgB;CAC1B,SAAS;AACX;;AAoCA,MAAa,0BAA0C;CACrD,OAAO;EACL;GAAE,KAAK;GAAY,SAAS;EAAK;EACjC;GAAE,KAAK;GAAY,SAAS;EAAK;EACjC;GAAE,KAAK;GAAc,SAAS;EAAK;CACrC;CACA,SAAS,EAAE,UAAU,MAAM;AAC7B;;;;;;AAOA,SAAgB,gBAAgB,QAA2C,KAA+B;CAGxG,IAAI,CAAC,QAAQ,OAAO,mBAAmB,SAAS,GAAG;CAEnD,OAAO,OAAO,MAAM,MAAM,SAAS,KAAK,QAAQ,OAAO,KAAK,OAAO;AACrE;;;;;AAMA,SAAgB,sBAAsB,QAAqE;CACzG,IAAI,CAAC,QAAQ,OAAO;CACpB,MAAM,OAAO,OAAO,MAAM,MAAM,MAAM,EAAE,QAAQ,aAAa,EAAE,OAAO;CACtE,IAAI,CAAC,MAAM,OAAO;CAElB,OAAO;EAAE,GAAG;EAAwB,GAAI,KAAK,UAAU,CAAC;CAAG;AAC7D;;AAGA,SAAgB,gBAAgB,QAAoD;CAClF,IAAI,CAAC,QAAQ,OAAO;CAEpB,OAAO,gBAAgB,QAAQ,UAAU,KAAK,CAAC,OAAO,QAAQ;AAChE;;AAGA,SAAgB,qBAAqB,QAA8D;CACjG,IAAI,CAAC,QAAQ,OAAO,CAAC,GAAG,kBAAkB;CAE1C,OAAO,OAAO,MAAM,QAAQ,SAAS,KAAK,OAAO,CAAC,CAAC,KAAK,SAAS,KAAK,GAAG;AAC3E"}
+{"version":3,"file":"workflow.mjs","names":[],"sources":["../src/workflow.ts"],"sourcesContent":["import type { Id, IsoDateTime } from './common'\nimport { DEFAULT_SCREENING_CONFIG, type RiskPolicyConfig, type ScreeningStepConfig } from './risk'\n\n/**\n * Workflows (Phase 19).\n *\n * An organization-scoped, reusable recipe that determines the order of the\n * coarse verification stages, lets each be turned off, and can skip OCR parsing\n * (capture-only). Workflows are optional: a session created without one runs the\n * default pipeline (document → liveness → face match, OCR on). A workflow's\n * config is snapshotted onto each session at creation, so editing it never\n * disturbs sessions already in flight.\n */\n\n/** A coarse verification stage a workflow can order and toggle. */\nexport type WorkflowStepKey = 'document' | 'screening' | 'address' | 'liveness' | 'face_match'\n\n/**\n * The default pipeline's stages, in canonical order — what runs when a session\n * has no workflow. `address` is deliberately NOT here: it's an opt-in stage,\n * available only on custom workflows.\n */\nexport const WORKFLOW_STEP_KEYS: readonly WorkflowStepKey[] = ['document', 'liveness', 'face_match']\n\n/**\n * Every stage a custom workflow may include, in canonical order. Used by the\n * workflow editor and to validate/normalise stored steps — a superset of\n * {@link WORKFLOW_STEP_KEYS} that adds the opt-in `screening` and `address` stages.\n */\nexport const AVAILABLE_WORKFLOW_STEP_KEYS: readonly WorkflowStepKey[] = [\n  'document',\n  'screening',\n  'address',\n  'liveness',\n  'face_match',\n]\n\n/** A method the address stage uses to corroborate the user's address. */\nexport type AddressMethod = 'poa_document' | 'device_location' | 'geocode_lookup'\n\n/** Every selectable address-verification method, in display order. */\nexport const ADDRESS_METHODS: readonly AddressMethod[] = ['poa_document', 'device_location', 'geocode_lookup']\n\n/** What a failed/low-confidence address result does to the session. */\nexport type AddressOnFail = 'review' | 'reject'\n\n/** Configuration for the `address` stage, carried on its {@link WorkflowStep}. */\nexport interface AddressStepConfig {\n  /** Methods to run; at least one when the stage is enabled. */\n  methods: AddressMethod[]\n  /**\n   * What a failed or low-confidence result does. `review` (default) flags the\n   * session for a human; `reject` fails it outright.\n   */\n  on_fail: AddressOnFail\n  /**\n   * Minimum address-verification confidence in [0, 1] to auto-verify the address.\n   * A passed address scoring below this is routed to manual review (the gate is\n   * never a rejection). Omitted falls back to the project `addressThreshold`.\n   */\n  auto_approve_threshold?: number\n}\n\n/** The default address config applied when the stage is enabled without one. */\nexport const DEFAULT_ADDRESS_CONFIG: AddressStepConfig = {\n  methods: ['geocode_lookup'],\n  on_fail: 'review',\n}\n\n/** One stage within a workflow, in pipeline order, on or off. */\nexport interface WorkflowStep {\n  key: WorkflowStepKey\n  enabled: boolean\n  /** Stage-specific configuration, used by the `address` and `screening` stages. */\n  config?: AddressStepConfig | ScreeningStepConfig\n}\n\n/** Workflow-wide toggles. */\nexport interface WorkflowOptions {\n  /**\n   * Skip OCR parsing — capture the document image but don't extract fields.\n   * Useful when Arkyc is only used for data capture and the assets are handed\n   * to a third party. Disables the document portrait too, so face match can't run.\n   */\n  skip_ocr: boolean\n  /** Minimum age in years, from the extracted date of birth (`UNDERAGE`). */\n  min_age?: number\n  /** How each risk signal affects the decision. Unlisted signals route to review. */\n  risk_policy?: RiskPolicyConfig\n}\n\n/** The portable config of a workflow: ordered stages + options. */\nexport interface WorkflowConfig {\n  steps: WorkflowStep[]\n  options: WorkflowOptions\n}\n\n/** A saved, organization-scoped workflow. */\nexport interface Workflow extends WorkflowConfig {\n  id: Id\n  organization_id: Id\n  name: string\n  created_at: IsoDateTime\n  updated_at: IsoDateTime\n}\n\n/** The default pipeline applied when a session has no workflow. */\nexport const DEFAULT_WORKFLOW_CONFIG: WorkflowConfig = {\n  steps: [\n    { key: 'document', enabled: true },\n    { key: 'liveness', enabled: true },\n    { key: 'face_match', enabled: true },\n  ],\n  options: { skip_ocr: false },\n}\n\n/**\n * Whether a stage runs under a config. A `null` config means \"no workflow\" — the\n * default pipeline, where every stage runs. Within a real config, a stage that is\n * absent or `enabled: false` does not run.\n */\nexport function workflowEnables(config: WorkflowConfig | null | undefined, key: WorkflowStepKey): boolean {\n  // No workflow runs the default pipeline only — opt-in stages (`screening`, `address`) are\n  // off unless a custom workflow turns them on.\n  if (!config) return WORKFLOW_STEP_KEYS.includes(key)\n\n  return config.steps.some((step) => step.key === key && step.enabled)\n}\n\n/**\n * The resolved address config for a session's workflow, or `null` when the\n * address stage isn't enabled. Missing fields fall back to {@link DEFAULT_ADDRESS_CONFIG}.\n */\nexport function workflowAddressConfig(config: WorkflowConfig | null | undefined): AddressStepConfig | null {\n  if (!config) return null\n  const step = config.steps.find((s) => s.key === 'address' && s.enabled)\n  if (!step) return null\n\n  return { ...DEFAULT_ADDRESS_CONFIG, ...((step.config as AddressStepConfig | undefined) ?? {}) }\n}\n\n/**\n * The resolved screening config for a session's workflow, or `null` when the\n * screening stage isn't enabled. Screening needs OCR fields to screen.\n */\nexport function workflowScreeningConfig(config: WorkflowConfig | null | undefined): ScreeningStepConfig | null {\n  if (!config || !workflowRunsOcr(config)) return null\n  const step = config.steps.find((s) => s.key === 'screening' && s.enabled)\n  if (!step) return null\n\n  return { ...DEFAULT_SCREENING_CONFIG, ...((step.config as ScreeningStepConfig | undefined) ?? {}) }\n}\n\n/** Whether OCR parsing should run: the document stage is on and `skip_ocr` is off. */\nexport function workflowRunsOcr(config: WorkflowConfig | null | undefined): boolean {\n  if (!config) return true\n\n  return workflowEnables(config, 'document') && !config.options.skip_ocr\n}\n\n/** The enabled stages in pipeline order (used by the widget to sequence its steps). */\nexport function workflowEnabledSteps(config: WorkflowConfig | null | undefined): WorkflowStepKey[] {\n  if (!config) return [...WORKFLOW_STEP_KEYS]\n\n  return config.steps.filter((step) => step.enabled).map((step) => step.key)\n}\n"],"mappings":";;;;;;;AAsBA,MAAa,qBAAiD;CAAC;CAAY;CAAY;AAAY;;;;;;AAOnG,MAAa,+BAA2D;CACtE;CACA;CACA;CACA;CACA;AACF;;AAMA,MAAa,kBAA4C;CAAC;CAAgB;CAAmB;AAAgB;;AAuB7G,MAAa,yBAA4C;CACvD,SAAS,CAAC,gBAAgB;CAC1B,SAAS;AACX;;AAwCA,MAAa,0BAA0C;CACrD,OAAO;EACL;GAAE,KAAK;GAAY,SAAS;EAAK;EACjC;GAAE,KAAK;GAAY,SAAS;EAAK;EACjC;GAAE,KAAK;GAAc,SAAS;EAAK;CACrC;CACA,SAAS,EAAE,UAAU,MAAM;AAC7B;;;;;;AAOA,SAAgB,gBAAgB,QAA2C,KAA+B;CAGxG,IAAI,CAAC,QAAQ,OAAO,mBAAmB,SAAS,GAAG;CAEnD,OAAO,OAAO,MAAM,MAAM,SAAS,KAAK,QAAQ,OAAO,KAAK,OAAO;AACrE;;;;;AAMA,SAAgB,sBAAsB,QAAqE;CACzG,IAAI,CAAC,QAAQ,OAAO;CACpB,MAAM,OAAO,OAAO,MAAM,MAAM,MAAM,EAAE,QAAQ,aAAa,EAAE,OAAO;CACtE,IAAI,CAAC,MAAM,OAAO;CAElB,OAAO;EAAE,GAAG;EAAwB,GAAK,KAAK,UAA4C,CAAC;CAAG;AAChG;;;;;AAMA,SAAgB,wBAAwB,QAAuE;CAC7G,IAAI,CAAC,UAAU,CAAC,gBAAgB,MAAM,GAAG,OAAO;CAChD,MAAM,OAAO,OAAO,MAAM,MAAM,MAAM,EAAE,QAAQ,eAAe,EAAE,OAAO;CACxE,IAAI,CAAC,MAAM,OAAO;CAElB,OAAO;EAAE,GAAG;EAA0B,GAAK,KAAK,UAA8C,CAAC;CAAG;AACpG;;AAGA,SAAgB,gBAAgB,QAAoD;CAClF,IAAI,CAAC,QAAQ,OAAO;CAEpB,OAAO,gBAAgB,QAAQ,UAAU,KAAK,CAAC,OAAO,QAAQ;AAChE;;AAGA,SAAgB,qBAAqB,QAA8D;CACjG,IAAI,CAAC,QAAQ,OAAO,CAAC,GAAG,kBAAkB;CAE1C,OAAO,OAAO,MAAM,QAAQ,SAAS,KAAK,OAAO,CAAC,CAAC,KAAK,SAAS,KAAK,GAAG;AAC3E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkyc/types",
-  "version": "1.2.11",
+  "version": "2.1.0",
   "description": "Shared domain types and contracts for Arkyc",
   "license": "MIT",
   "keywords": [