@kypacs/sdk 1.1.2 → 1.3.0

package/dist/types/generated.d.ts

@@ -689,7 +689,7 @@ export type paths = {
         put?: never;
         /**
          * Approve identified officers and resume screening
-         * @description Resumes a KYB verification paused at OFFICERS_IDENTIFIED (when the tenant has enabled requireOfficerReviewBeforeScreening). Runs sanctions screening for the entity, officers, and UBOs, then finalises the decision.
+         * @description Resumes a KYB verification paused at OFFICERS_IDENTIFIED (when the tenant has enabled requireOfficerReviewBeforeScreening). Runs sanctions screening for the entity, officers, and UBOs, then finalises the decision. Returns the updated BusinessDetail so SDK consumers can read the post-approval state without a follow-up GET.
          */
         post: operations["BusinessController_approveOfficers"];
         delete?: never;
@@ -698,6 +698,26 @@ export type paths = {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/businesses/{id}/officers/{officerId}/link-verification": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Link an existing APPROVED individual KYC to a business officer
+         * @description Connects an already-completed individual verification to a `BusinessOfficer`. Use this when the applicant completed personal KYC before starting the business application; for the inverse flow (officer who has NOT yet completed KYC), use `verifyUbo`. Re-runs sanctions screening using the *decrypted* full name from the linked verification — registry names and KYC names often differ in formatting, and screening on the KYC name yields a more accurate AML match. Rejects if the officer is already linked.
+         */
+        post: operations["BusinessController_linkOfficerVerification"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/businesses/{id}/refresh-registry": {
         parameters: {
             query?: never;
@@ -818,6 +838,46 @@ export type paths = {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/businesses/{id}/ubos/{uboId}/link-verification": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Link an existing APPROVED individual KYC to a beneficial owner
+         * @description Same as `linkOfficerVerification` but for a `BeneficialOwner`. Rejects corporate UBOs (`ownerType: COMPANY`) — corporate UBOs need chain-of-ownership investigation, not a personal KYC link.
+         */
+        post: operations["BusinessController_linkUboVerification"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/businesses/lookup-officers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Look up officer hints for a registered business (no entity created)
+         * @description Returns trimmed officer hints from the registry without creating a `BusinessEntity` and without consuming KYB quota. Designed for "which officer am I?" pickers in multi-step KYB intake wizards. Rate-limited at 100 requests/hour per user (the endpoint returns officer PII, so this throttles abuse). Returns `{ officers: [] }` for jurisdictions without an officer-capable registry adapter.
+         */
+        post: operations["BusinessController_lookupOfficers"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/businesses/search": {
         parameters: {
             query?: never;
@@ -1246,6 +1306,66 @@ export type paths = {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/documents/attach": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Attach a CLEAN pre-staged document to a verification
+         * @description Copies the pre-staged storage object from `pre-stage/...` to the verification prefix (`{verificationId}/...`), creates a Document row in CLEAN status (already scanned), and marks the pre-stage row as attached so the cleanup job leaves it alone. The pre-stage must be CLEAN (scanning succeeded), not expired, and owned by the same tenant as the verification. Verification must be in PENDING or DOCUMENT_UPLOADED.
+         */
+        post: operations["DocumentController_attach"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/documents/pre-stage": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Generate a pre-signed upload URL for a document BEFORE a verification exists
+         * @description Used by multi-step KYB intake wizards that collect documents and officer selections locally and commit on submit. The returned `preStageId` is the capability token: after PUTting the file to `uploadUrl`, call `/pre-stage/:preStageId/confirm` to virus-scan, then `/attach` to attach it to a verification. Pre-staged documents expire after 4 hours.
+         */
+        post: operations["DocumentController_preStageUpload"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/documents/pre-stage/{preStageId}/confirm": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Confirm a pre-staged upload completed; enqueue virus scan
+         * @description Verifies the bytes exist in storage, transitions the pre-stage row from UPLOADED to SCANNING, and enqueues a virus-scan job. Call after the client PUTs to the pre-signed URL returned by `/pre-stage`. Tenant scoping is re-checked here — a leaked preStageId cannot be confirmed from another tenant's context (returns 404).
+         */
+        post: operations["DocumentController_confirmPreStage"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/documents/supported-countries": {
         parameters: {
             query?: never;
@@ -3577,6 +3697,18 @@ export type components = {
              */
             assigneeId: string;
         };
+        AttachPreStagedDocumentSwaggerDto: {
+            /**
+             * Format: uuid
+             * @description Pre-stage UUID returned by /documents/pre-stage
+             */
+            preStageId: string;
+            /**
+             * Format: uuid
+             * @description Target verification UUID
+             */
+            verificationId: string;
+        };
         AuditLogPaginatedResponseDto: {
             data: components["schemas"]["AuditLogRecordDto"][];
             hasMore: boolean;
@@ -5417,6 +5549,13 @@ export type components = {
             name: string;
             ruleCount: number;
         };
+        LinkVerificationSwaggerDto: {
+            /**
+             * Format: uuid
+             * @description UUID of an existing INDIVIDUAL verification in APPROVED status to link.
+             */
+            verificationId: string;
+        };
         LogoutDto: {
             /**
              * @description Refresh token to revoke, effectively logging the user out
@@ -5424,6 +5563,22 @@ export type components = {
              */
             refresh_token: string;
         };
+        LookupOfficersResponseDto: {
+            officers: components["schemas"]["OfficerHintDto"][];
+        };
+        LookupOfficersSwaggerDto: {
+            /**
+             * @description Jurisdiction ISO country code
+             * @example NZ
+             * @enum {string}
+             */
+            jurisdiction: "NZ" | "AU" | "AS" | "CK" | "FJ" | "KI" | "NR" | "NU" | "PG" | "SB" | "TK" | "TO" | "TV" | "VU" | "WS";
+            /**
+             * @description Registration number (NZBN, NZ Company Number, ABN, or ACN)
+             * @example 9429041910672
+             */
+            registrationNumber: string;
+        };
         MonitoringAlertResponseDto: {
             /** Format: date-time */
             acknowledgedAt: Record<string, never> | null;
@@ -5478,6 +5633,19 @@ export type components = {
             /** @enum {string} */
             status: "LICENSED" | "NOT_FOUND" | "NOT_APPLICABLE";
         };
+        OfficerHintDto: {
+            /** Format: date */
+            appointmentDate: Record<string, never> | null;
+            /** @description Full name as recorded by the registry */
+            fullName: string;
+            /** @enum {string} */
+            role: "DIRECTOR" | "SHAREHOLDER" | "SECRETARY" | "OTHER";
+            /**
+             * @description Whether the officer is currently active or has ceased.
+             * @enum {string}
+             */
+            state: "current" | "historical";
+        };
         OwnershipNodeDto: {
             /** @description Recursive child ownership nodes */
             children: components["schemas"]["OwnershipNodeDto"][];
@@ -5640,6 +5808,61 @@ export type components = {
             month: string;
             rejectedCount: number;
         };
+        PreStagedDocumentResponseDto: {
+            /**
+             * Format: uuid
+             * @description If the pre-stage has been attached, the resulting Document UUID
+             */
+            attachedDocumentId: Record<string, never> | null;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            expiresAt: string;
+            fileName: string;
+            /** @description Size in bytes */
+            fileSize: number;
+            /** Format: uuid */
+            id: string;
+            mimeType: string;
+            /** @enum {string} */
+            status: "UPLOADED" | "SCANNING" | "CLEAN" | "INFECTED" | "PROCESSING" | "PROCESSED" | "FAILED";
+            /** Format: uuid */
+            tenantId: string;
+            /** @enum {string} */
+            type: "PASSPORT" | "DRIVERS_LICENCE" | "NATIONAL_ID" | "BIRTH_CERTIFICATE" | "UTILITY_BILL" | "BANK_STATEMENT" | "COMPANY_REGISTRATION" | "SELFIE" | "OTHER";
+        };
+        PreStageUploadSwaggerDto: {
+            /**
+             * @description MIME type
+             * @enum {string}
+             */
+            contentType: "image/jpeg" | "image/png" | "image/webp" | "application/pdf";
+            /** @description Original file name */
+            fileName: string;
+            /** @description Expected file size in bytes (max 20MB) */
+            fileSize: number;
+            /**
+             * @description Document type
+             * @enum {string}
+             */
+            type: "PASSPORT" | "DRIVERS_LICENCE" | "NATIONAL_ID" | "BIRTH_CERTIFICATE" | "UTILITY_BILL" | "BANK_STATEMENT" | "COMPANY_REGISTRATION" | "SELFIE" | "OTHER";
+        };
+        PreStageUploadUrlResponseDto: {
+            /**
+             * Format: date-time
+             * @description When the pre-signed URL expires
+             */
+            expiresAt: string;
+            /** @description Internal storage key under the pre-stage/ prefix */
+            key: string;
+            /**
+             * Format: uuid
+             * @description New pre-stage UUID — pass back to /documents/pre-stage/:preStageId/confirm
+             */
+            preStageId: string;
+            /** @description Pre-signed SeaweedFS URL the client PUTs the file to */
+            uploadUrl: string;
+        };
         RefreshTokenDto: {
             /**
              * @description Refresh token obtained from a previous token exchange or refresh
@@ -8641,12 +8864,14 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Officers approved; screening + decision complete */
+            /** @description Officers approved; returns the updated business detail */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["BusinessDetailResponseDto"];
+                };
             };
             /** @description Business entity not found */
             404: {
@@ -8668,6 +8893,62 @@ export interface operations {
             };
         };
     };
+    BusinessController_linkOfficerVerification: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Business entity UUID */
+                id: string;
+                /** @description Business officer UUID */
+                officerId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LinkVerificationSwaggerDto"];
+            };
+        };
+        responses: {
+            /** @description Officer linked; returns the updated officer with new screeningId */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BusinessOfficerResponseDto"];
+                };
+            };
+            /** @description Business or officer not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+            /** @description Officer is already linked to a verification */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+            /** @description Verification cannot be linked (wrong type, status, or tenant) */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+        };
+    };
     BusinessController_refreshRegistry: {
         parameters: {
             query?: never;
@@ -8870,6 +9151,104 @@ export interface operations {
             };
         };
     };
+    BusinessController_linkUboVerification: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Business entity UUID */
+                id: string;
+                /** @description Beneficial owner UUID */
+                uboId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LinkVerificationSwaggerDto"];
+            };
+        };
+        responses: {
+            /** @description UBO linked; returns the updated UBO with new screeningId */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BeneficialOwnerResponseDto"];
+                };
+            };
+            /** @description Business or UBO not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+            /** @description UBO is already linked to a verification */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+            /** @description Verification cannot be linked, or UBO is COMPANY type */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+        };
+    };
+    BusinessController_lookupOfficers: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LookupOfficersSwaggerDto"];
+            };
+        };
+        responses: {
+            /** @description Officer hints from the registry (possibly empty) */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LookupOfficersResponseDto"];
+                };
+            };
+            /** @description Invalid request body */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+            /** @description Rate limit exceeded — too many lookups per hour */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+        };
+    };
     BusinessController_search: {
         parameters: {
             query?: never;
@@ -10288,6 +10667,131 @@ export interface operations {
             };
         };
     };
+    DocumentController_attach: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AttachPreStagedDocumentSwaggerDto"];
+            };
+        };
+        responses: {
+            /** @description Document attached */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DocumentResponseDto"];
+                };
+            };
+            /** @description Pre-stage or verification not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+            /** @description Pre-stage not CLEAN, already attached, or verification not in an upload-accepting status */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+            /** @description Pre-stage has expired */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+        };
+    };
+    DocumentController_preStageUpload: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PreStageUploadSwaggerDto"];
+            };
+        };
+        responses: {
+            /** @description Pre-signed upload URL generated */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PreStageUploadUrlResponseDto"];
+                };
+            };
+            /** @description Invalid body or content type */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+        };
+    };
+    DocumentController_confirmPreStage: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Pre-stage UUID */
+                preStageId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Upload confirmed; scanning enqueued */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PreStagedDocumentResponseDto"];
+                };
+            };
+            /** @description Pre-stage not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+            /** @description Pre-stage is not in UPLOADED state */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponseDto"];
+                };
+            };
+        };
+    };
     DocumentController_getSupportedCountries: {
         parameters: {
             query?: never;