@fill-easy/api 1.0.34 → 1.0.36

package/dist/openapi.d.ts

@@ -903,6 +903,8 @@ export interface paths {
          *     **Fallback:** Provide `companyName` if `companyId` is unavailable — request will be processed manually.
          *
          *     **Document Request:** Provide `documentId` from `/cra/{countryCode}/search/documents` to request specific document.
+         *
+         *     **Document Type:** Each country has a `defaultDocumentType` (see [`/cra/info`](#tag/CorpVerify/operation/craInfo)). Omitting `documentType` selects that default. To request a specific document, pass its `name` or alias from the country's `documentTypes` list.
          */
         post: operations["craRequest"];
         delete?: never;
@@ -1051,7 +1053,9 @@ export interface paths {
         /**
          * Info
          * @description Returns metadata and a list of all countries supported by the CorpVerify service,
-         *     including their automation status, available search capabilities, and report contents.
+         *     including their automation status, available search capabilities, report contents,
+         *     and the available document types per country. Each country includes a `defaultDocumentType`
+         *     indicating which document is returned when `documentType` is omitted from a `/cra/request` call.
          *
          *     > For an up-to-date version of the same data, please view the [CorpVerify Country Coverage table](countries).
          */
@@ -1166,10 +1170,44 @@ export interface components {
                 /** @description Whether registration information is available */
                 registration: boolean;
                 /** @description Whether shareholder information is available */
-                sharedholder: boolean;
+                shareholder: boolean;
                 /** @description Whether financial information is available */
                 financial: boolean;
             };
+            /**
+             * @description The document type used when `documentType` is omitted from a `/cra/request` call.
+             *     Always matches one of the `name` values in `documentTypes`.
+             * @example Company Particulars
+             */
+            defaultDocumentType: string;
+            /** @description Available document types for this country */
+            documentTypes: {
+                /**
+                 * @description Document type name
+                 * @example Company Particulars
+                 */
+                name: string;
+                /**
+                 * @description List of content fields included in this document type
+                 * @example [
+                 *       "registration",
+                 *       "shareholder",
+                 *       "financial"
+                 *     ]
+                 */
+                contents: components["schemas"]["DocumentContents"][];
+                /**
+                 * @description Source of the document
+                 * @example Hong Kong Companies Registry
+                 */
+                source: string;
+                /**
+                 * Format: uri
+                 * @description URL to a sample document
+                 * @example https://cra-bucket-ap-east-1-prod.s3.ap-east-1.amazonaws.com/samples/HK_company-particulars.pdf
+                 */
+                sampleUrl: string;
+            }[];
         };
         CraInvalidCountryError: {
             /**
@@ -1185,6 +1223,12 @@ export interface components {
              */
             error: string;
         };
+        /**
+         * @description Data fields that can be included in company registry documents
+         * @example shareholder
+         * @enum {string}
+         */
+        DocumentContents: "registration" | "shareholder" | "financial";
         /**
          * @description JWT token
          * @example eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U
@@ -1666,14 +1710,25 @@ export interface operations {
             path?: never;
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                "application/json": {
+                    token: components["schemas"]["Token"];
+                };
+            };
+        };
         responses: {
             /** @description Success */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": {
+                        message?: string;
+                        token?: string;
+                    };
+                };
             };
         };
     };
@@ -1899,8 +1954,8 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Success */
-            200: {
+            /** @description Redirect to client application */
+            302: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -2108,11 +2163,17 @@ export interface operations {
             };
         };
         responses: {
+            /** @description Success */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": {
+                        url?: string;
+                        token?: string;
+                    };
+                };
             };
         };
     };
@@ -2125,7 +2186,8 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            200: {
+            /** @description Redirect to Singpass authorization */
+            302: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -2142,7 +2204,8 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            200: {
+            /** @description Redirect to client application */
+            302: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -2159,7 +2222,8 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            200: {
+            /** @description Redirect to client application */
+            302: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -2176,7 +2240,8 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            200: {
+            /** @description Redirect to client application */
+            302: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -2193,11 +2258,18 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
+            /** @description JWK Set */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": {
+                        keys: {
+                            [key: string]: unknown;
+                        }[];
+                    };
+                };
             };
         };
     };
@@ -2227,6 +2299,8 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
+                        /** @description Status message */
+                        message?: string;
                         /** @description URL that should be shown to the user (usually as a QR code) */
                         url?: string;
                         /** @description Used to poll requested data */
@@ -2234,6 +2308,17 @@ export interface operations {
                     };
                 };
             };
+            /** @description Pending - Data not yet available */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        message?: string;
+                    };
+                };
+            };
             /** @description Bad Request - Invalid request body. Ensure that your request body complies with the requirements. */
             400: {
                 headers: {
@@ -2357,6 +2442,18 @@ export interface operations {
                 content: {
                     "application/json": {
                         faceImage?: string;
+                        sceneImage?: string;
+                        message?: string;
+                    };
+                };
+            };
+            /** @description Pending */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
                         message?: string;
                     };
                 };
@@ -2442,7 +2539,30 @@ export interface operations {
                 content: {
                     "application/json": {
                         message?: string;
-                        token?: components["schemas"]["Token"];
+                        /** @description Response data from UAE Pass */
+                        data?: unknown;
+                    };
+                };
+            };
+            /** @description Pending - Authentication not yet complete */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        message?: string;
+                    };
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        message?: string;
                     };
                 };
             };
@@ -2457,13 +2577,24 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Success */
-            200: {
+            /** @description Redirect to client application */
+            302: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error?: string;
+                    };
+                };
+            };
         };
     };
     uaepassLogout: {
@@ -2879,13 +3010,7 @@ export interface operations {
                     };
                 };
             };
-            /** @description Invalid request parameters */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
+            400: components["responses"]["BadRequest"];
             /** @description Upstream verification service error */
             502: {
                 headers: {
@@ -3022,8 +3147,9 @@ export interface operations {
                     /** @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code (case insensitive) */
                     countryCode: string;
                     /**
-                     * @description Type of document
-                     * @default companySearch
+                     * @description The document type to retrieve. Must match a `name` (or alias) from the country's `documentTypes` list in [`/cra/info`](#tag/CorpVerify/operation/craInfo).
+                     *
+                     *     If omitted, defaults to the country's `defaultDocumentType` from `/cra/info`.
                      */
                     documentType?: string;
                     /** @description Year of the document */
@@ -3290,13 +3416,7 @@ export interface operations {
                     };
                 };
             };
-            /** @description Invalid token */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
+            400: components["responses"]["BadRequest"];
             /** @description Internal server error */
             500: {
                 headers: {
@@ -3353,7 +3473,12 @@ export interface operations {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        message: "search error";
+                    };
+                };
             };
         };
     };
@@ -3448,7 +3573,12 @@ export interface operations {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        message: "search error";
+                    };
+                };
             };
         };
     };
@@ -3502,7 +3632,12 @@ export interface operations {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        message: "search error";
+                    };
+                };
             };
         };
     };
@@ -3626,11 +3761,29 @@ export interface operations {
             };
         };
         responses: {
+            /** @description Report ready */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": {
+                        message?: string;
+                        /** @description Presigned URL to download the report */
+                        data?: string;
+                    };
+                };
+            };
+            /** @description Report is pending */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        message?: string;
+                    };
+                };
             };
         };
     };
@@ -3656,11 +3809,25 @@ export interface operations {
             };
         };
         responses: {
+            /** @description Search results */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": {
+                        /**
+                         * @description Property Reference Number
+                         * @example HK1234567
+                         */
+                        prn: string;
+                        /**
+                         * @description Free format address in English
+                         * @example FLAT A, 8/F, BLOCK B, KAI TAK COMMERCIAL BUILDING, 86 DES VOEUX ROAD
+                         */
+                        free_format_addr_eng: string;
+                    }[];
+                };
             };
         };
     };

package/package.json

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