@fill-easy/api 1.0.31 → 1.0.33

package/dist/openapi.d.ts

@@ -742,83 +742,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/ocr/request": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Request
-         * @description Initialize a verification session by passing your callback URLs and the
-         *     document type.
-         *
-         *
-         *     **Browser Flow:**
-         *
-         *     Returns a **launch URL** (open on a **mobile browser**) and a **JWT**
-         *     **`token`** that you must keep for polling status.
-         *     After the user completes or cancels the H5 flow, the browser is
-         *     redirected to your provided callback URL.
-         *
-         *
-         *     **Mobile App Flow:**
-         *
-         *     Use the returned **`url`** to open an in-app web view or the system
-         *     browser on the phone.
-         *     Use the returned **`token`** later with `/ocr/poll` to check the final
-         *     decision.
-         *
-         *
-         *     **Note:** The redirect is **UX-only**; you still need to call `/ocr/poll` with the
-         *     returned `token` to obtain the authoritative decision.
-         */
-        post: operations["request1"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/ocr/poll": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Poll
-         * @description Check the status of a verification using the **`token`** returned by
-         *     `/ocr/request`.
-         *
-         *
-         *     - Returns **202 Accepted** while the verification is **in progress**.
-         *
-         *     - Returns **200 OK** when the verification is **completed** (Success /
-         *     Failure / Void\*).
-         *
-         *     - Always responds with a concise **`summary`** (no raw payloads needed).
-         *
-         *
-         *     Send **only the** **`token`**. It already encapsulates the session
-         *     identifiers.
-         *
-         *
-         *     **Terminal states:** `Success`, `Failure`, or `Void\*`.
-         */
-        post: operations["ocrPoll"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/kyc/cn/identity": {
         parameters: {
             query?: never;
@@ -1429,7 +1352,7 @@ export interface components {
          * @example Private Company
          * @enum {string}
          */
-        registrationDetail: "Company Limited by Shares" | "Registered Non-Hong Kong Company" | "Company Limited by Guarantee" | "Unlimited Company" | "Registered Society/Organization" | "Open-ended Fund Company" | "Limited Partnership Fund" | "Public Company" | "Private Company" | "Foreign Company" | "Foreign Company Branch" | "Registered Australian Corporation under non-Corporations Law" | "Company Limited by Both Shares and Guarantees" | "No Liability Company" | "Sole Proprietorship/ Partnership" | "Sole Proprietorship" | "Limited Liability Partnership" | "Limited Partnership" | "Unlimited Partnership" | "Local Company" | "Juristic Ordinary Partnership" | "Foreign Juristic Person" | "Joint Venture" | "Chamber of Commerce" | "N/A";
+        registrationDetail: "Company Limited by Shares" | "Registered Non-Hong Kong Company" | "Company Limited by Guarantee" | "Limited Company" | "Unlimited Company" | "Registered Society/Organization" | "Open-ended Fund Company" | "Open-ended Investment Company" | "Limited Partnership Fund" | "Public Company" | "Private Company" | "Foreign Company" | "Foreign Company Branch" | "Registered Overseas Entity" | "Registered Australian Corporation under non-Corporations Law" | "Company Limited by Both Shares and Guarantees" | "No Liability Company" | "Sole Proprietorship/ Partnership" | "Sole Proprietorship" | "Limited Liability Partnership" | "Limited Partnership" | "Unlimited Partnership" | "Local Company" | "Juristic Ordinary Partnership" | "Foreign Juristic Person" | "Joint Venture" | "Chamber of Commerce" | "Private Limited by Guarantee (Section 60 Exemption)" | "Assurance Company" | "European Economic Interest Grouping" | "Royal Charter Body" | "United Kingdom Societas" | "United Kingdom Economic Interest Grouping" | "Charitable Incorporated Organisation" | "Educational Corporation" | "N/A";
     };
     responses: {
         /** @description Unauthorized - Token is missing, invalid, or expired */
@@ -2577,280 +2500,6 @@ export interface operations {
             500: components["responses"]["InternalServerError"];
         };
     };
-    request1: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": {
-                    /**
-                     * Format: uri
-                     * @description Where to redirect the user **after success**.
-                     *     Must be publicly reachable over **https**.
-                     * @example https://example.com/ocr/complete
-                     */
-                    completeCallbackUrl: string;
-                    /**
-                     * Format: uri
-                     * @description Where to redirect the user if they **cancel/exit**.
-                     *     Must be publicly reachable over **https**.
-                     * @example https://example.com/ocr/interrupt
-                     */
-                    interruptCallbackUrl: string;
-                    /**
-                     * @description The identity document type to verify.
-                     *     `00000001003` (Passport), `08520000002` (HKID New), `08520000001` (HKID Old).
-                     *     Use the exact code for your target document.
-                     * @example 08520000002
-                     * @enum {string}
-                     */
-                    docType: "00000001003" | "08520000002" | "08520000001";
-                };
-            };
-        };
-        responses: {
-            /** @description Successfully initialized verification session */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        /**
-                         * Format: uri
-                         * @description Launch URL to open on a mobile browser or in an in-app web view.
-                         *     This URL contains the configuration for the H5 verification flow.
-                         * @example https://<cdn>/page/realid-fe/index.html?clientcfg=eyJ...
-                         */
-                        url: string;
-                        /**
-                         * @description JWT token carrying bizId and transactionId.
-                         *     Store this token to poll for verification results using `/ocr/poll`.
-                         */
-                        token: components["schemas"]["Token"];
-                    };
-                };
-            };
-        };
-    };
-    ocrPoll: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": {
-                    /** @description The token returned by `POST /ocr/request` that encodes the session identifiers */
-                    token: components["schemas"]["Token"];
-                };
-            };
-        };
-        responses: {
-            /** @description Verification completed (Success / Failure / Void\*) */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        /**
-                         * @description Status message
-                         * @example Verification completed
-                         */
-                        message: string;
-                        summary: {
-                            /**
-                             * @description Overall eKYC verification result
-                             * @example Success
-                             * @enum {string}
-                             */
-                            ekycResult: "Success" | "Failure" | "Void";
-                            /**
-                             * @description Whether this is a terminal state (true for completed verifications)
-                             * @example true
-                             */
-                            isTerminal: boolean;
-                            /** @description Document verification details */
-                            document: {
-                                /**
-                                 * @description Document type code
-                                 * @example 08520000002
-                                 */
-                                type?: string;
-                                /**
-                                 * @description Document number (may be partially masked)
-                                 * @example F*********
-                                 */
-                                number?: string;
-                                /**
-                                 * @description Name of the document holder
-                                 * @example John, Smith
-                                 */
-                                holderName?: string;
-                                /**
-                                 * @description Date of birth (YYYY/MM/DD format)
-                                 * @example 2000/01/01
-                                 */
-                                dob?: string;
-                                /**
-                                 * @description Gender
-                                 * @example M
-                                 */
-                                sex?: string | null;
-                                /**
-                                 * @description Document issue date (YYYY/MM/DD format)
-                                 * @example 2021/11/11
-                                 */
-                                dateOfIssue?: string | null;
-                                /**
-                                 * @description Document expiry date (YYYY/MM/DD format)
-                                 * @example 2031/11/11
-                                 */
-                                dateOfExpiry?: string | null;
-                                /**
-                                 * @description Document verification decision
-                                 * @example Success
-                                 * @enum {string|null}
-                                 */
-                                decision?: "Success" | "Failure" | null;
-                            };
-                            /** @description Face verification details */
-                            face: {
-                                /**
-                                 * @description Liveness check result
-                                 * @example Success
-                                 * @enum {string|null}
-                                 */
-                                liveness?: "Success" | "Failure" | null;
-                                /**
-                                 * @description Liveness detection score
-                                 * @example 25
-                                 */
-                                livenessScore?: number | null;
-                                /**
-                                 * @description Face match score (0-100)
-                                 * @example 94
-                                 */
-                                matchScore?: number | null;
-                            };
-                            /** @description Risk assessment details */
-                            risk: {
-                                /**
-                                 * @description Risk assessment decision
-                                 * @example Success
-                                 * @enum {string|null}
-                                 */
-                                decision?: "Success" | "Failure" | null;
-                            };
-                        };
-                    };
-                };
-            };
-            /** @description Verification in progress */
-            202: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        /**
-                         * @description Status message
-                         * @example Verification in progress
-                         */
-                        message: string;
-                        summary: {
-                            /**
-                             * @description Current eKYC verification status
-                             * @example InProcess
-                             */
-                            ekycResult: string;
-                            /**
-                             * @description Whether this is a terminal state (false for in-progress verifications)
-                             * @example false
-                             */
-                            isTerminal: boolean;
-                            /** @description Document verification details (partial data during processing) */
-                            document: {
-                                /**
-                                 * @description Document type code
-                                 * @example 08520000002
-                                 */
-                                type?: string;
-                                /**
-                                 * @description Document number (may be partially masked or incomplete)
-                                 * @example F*******
-                                 */
-                                number?: string;
-                                /**
-                                 * @description Name of the document holder (may be incomplete)
-                                 * @example —
-                                 */
-                                holderName?: string;
-                                /**
-                                 * @description Date of birth (may be incomplete)
-                                 * @example —
-                                 */
-                                dob?: string;
-                                /**
-                                 * @description Gender
-                                 * @example M
-                                 */
-                                sex?: string | null;
-                                /**
-                                 * @description Document issue date
-                                 * @example 2031/11/11
-                                 */
-                                dateOfIssue?: string | null;
-                                /**
-                                 * @description Document expiry date
-                                 * @example 2031/11/11
-                                 */
-                                dateOfExpiry?: string | null;
-                                /**
-                                 * @description Document verification decision (null during processing)
-                                 * @example pass
-                                 */
-                                decision?: string | null;
-                            };
-                            /** @description Face verification details (null during processing) */
-                            face: {
-                                /**
-                                 * @description Liveness check result
-                                 * @example pass
-                                 */
-                                liveness?: string | null;
-                                /**
-                                 * @description Liveness detection score
-                                 * @example 50
-                                 */
-                                livenessScore?: number | null;
-                                /**
-                                 * @description Face match score
-                                 * @example 100
-                                 */
-                                matchScore?: number | null;
-                            };
-                            /** @description Risk assessment details (null during processing) */
-                            risk: {
-                                /**
-                                 * @description Risk assessment decision
-                                 * @example pass
-                                 */
-                                decision?: string | null;
-                            };
-                        };
-                    };
-                };
-            };
-        };
-    };
     kycCnIdentity: {
         parameters: {
             query?: never;
@@ -3727,9 +3376,8 @@ export interface operations {
                      * @description Optional filter by document type. (Country Specific)
                      *     - HK: financialStatement, annualReturn
                      *     - PH: GIS, AFS
-                     * @enum {string}
                      */
-                    documentType?: "financialStatement" | "annualReturn" | "GIS" | "AFS";
+                    documentType?: string;
                     /** @description Optional filter by year */
                     documentYear?: string;
                 };
@@ -3763,7 +3411,7 @@ export interface operations {
                             pages?: string;
                             /**
                              * Format: date
-                             * @description Filing date (YYYY-MM-DD format)
+                             * @description Filing date (YYYY-MM-DD format), can be date of processing or date filed depending on country
                              */
                             filingDate?: string;
                             /** @description Unique document identifier */
@@ -3772,6 +3420,16 @@ export interface operations {
                             companyId: string;
                             /** @description Whether the document has linked files */
                             hasLinked?: boolean;
+                            /**
+                             * @description Additional useful info regarding the document
+                             * @example {
+                             *       "made_up_date": "2025-08-26",
+                             *       "officer_name": "Bob Chan"
+                             *     }
+                             */
+                            description?: {
+                                [key: string]: string;
+                            };
                         }[];
                     };
                 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fill-easy/api",
-  "version": "1.0.31",
+  "version": "1.0.33",
   "type": "module",
   "description": "Type-safe SDK for Fill Easy API",
   "main": "dist/index.js",