@fill-easy/api 1.0.19 → 1.0.20

package/dist/openapi.d.ts

@@ -54,7 +54,6 @@ export interface paths {
          *     - Browser: Must be an HTTPS URL registered with iAM Smart
          *     - Mobile: Must be a universal link or custom scheme (e.g., `your-app://auth`)
          *       that your mobile app can handle
-         *
          */
         post: operations["iamSmartAuthentication"];
         delete?: never;
@@ -96,7 +95,6 @@ export interface paths {
          *
          *     The `formFields` array specifies which detail fields to request from the user.
          *     All requested fields will be displayed to the user in their iAM Smart app for approval.
-         *
          */
         post: operations["iamSmartFormFilling"];
         delete?: never;
@@ -133,7 +131,6 @@ export interface paths {
          *     - Must be a SHA-256 hash of the document content
          *     - Must be exactly 64 hexadecimal characters
          *     - Use SHA256withRSA signature algorithm (default)
-         *
          */
         post: operations["iamSmartHashSigning"];
         delete?: never;
@@ -170,7 +167,6 @@ export interface paths {
          *     - Must be a base64-encoded hash of the PDF file
          *     - The signed PDF will be returned with the signature embedded
          *     - PDF signature will be visible in PDF readers that support digital signatures
-         *
          */
         post: operations["iamSmartPdfSigning"];
         delete?: never;
@@ -208,7 +204,6 @@ export interface paths {
          *     - Verify user identity before sensitive operations
          *     - Refresh user authentication for extended sessions
          *     - Comply with security policies requiring periodic re-verification
-         *
          */
         post: operations["iamSmartReauthentication"];
         delete?: never;
@@ -259,7 +254,6 @@ export interface paths {
          *     If you request overlapping fields in both `profileFields` and `formData.formFields`,
          *     the `profileFields` takes precedence. You must display a consent page per iAM Smart
          *     UI/UX requirements when using profile fields.
-         *
          */
         post: operations["iamSmartAnonFormFilling"];
         delete?: never;
@@ -292,7 +286,6 @@ export interface paths {
          *
          *     - Must be a SHA-256 hash of the document content
          *     - Must be exactly 64 hexadecimal characters
-         *
          */
         post: operations["iamSmartAnonHashSigning"];
         delete?: never;
@@ -318,7 +311,6 @@ export interface paths {
          *
          *
          *     **Use the temporary token** with the polling endpoint to retrieve the signed document once the user completes the signing process.
-         *
          */
         post: operations["iamSmartAnonPdfSigning"];
         delete?: never;
@@ -347,7 +339,6 @@ export interface paths {
          * @description This endpoint is called by iAM Smart government servers to deliver
          *     the encrypted results of user authentication, form filling, or signing requests.
          *     The content is encrypted and must be decrypted using the CEK (Content Encryption Key).
-         *
          */
         post: operations["govCallback"];
         delete?: never;
@@ -374,7 +365,6 @@ export interface paths {
          * @description iAM Smart redirects the user to this endpoint after completing the authentication
          *     or service request flow. It processes the authorization code or error from
          *     iAM Smart and again redirects to the client's specified redirect URL.
-         *
          */
         get: operations["iamSmartRedirect"];
         put?: never;
@@ -692,7 +682,6 @@ export interface paths {
          *
          *     **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;
@@ -729,7 +718,6 @@ export interface paths {
          *
          *
          *     **Terminal states:** `Success`, `Failure`, or `Void\*`.
-         *
          */
         post: operations["ocrPoll"];
         delete?: never;
@@ -771,7 +759,6 @@ export interface paths {
          *
          *     In any case, the endpoint returns a JWT token that should be used with the
          *     `/cra/poll` endpoint to retrieve the document when ready.
-         *
          */
         post: operations["craRequest"];
         delete?: never;
@@ -802,7 +789,6 @@ export interface paths {
          *
          *     Once the report is ready, the endpoint will bill the service and return
          *     a presigned URL valid for 1 hour to download the PDF document.
-         *
          */
         post: operations["craPoll"];
         delete?: never;
@@ -838,7 +824,6 @@ export interface paths {
          *     Tokenized search (e.g. searching "PLE" will not result in "APPLE"): AU, SG
          *     Left partial search: HK
          *     Partial name search: US
-         *
          */
         post: operations["searchCompanies"];
         delete?: never;
@@ -870,7 +855,6 @@ export interface paths {
          *     Document categories include: Annual Return, Director / Secretary
          *     Changes, Charges Filed, Incorporation & Name Change, Liquidation &
          *     Deregistration, Registered Office / Address, Share Capital, and Other.
-         *
          */
         post: operations["searchDocuments"];
         delete?: never;
@@ -901,7 +885,6 @@ export interface paths {
          *     and other available details such as entity type, registration address, and remarks where
          *     applicable. The exact fields returned may vary depending on the data provided by each
          *     country’s registry.
-         *
          */
         post: operations["searchCompany"];
         delete?: never;
@@ -1096,13 +1079,11 @@ export interface components {
          *     Requested scope of authorization based on available services.
          *     Multiple scopes should be space-separated. Valid scopes are:
          *     eidapi_auth, eidapi_profiles, eidapi_formFilling, eidapi_sign, eidapi_fr, eidapi_bulksign
-         *
          * @example eidapi_auth eidapi_formFilling eidapi_sign
          */
         IamSmartScope: string;
         /**
          * @description iAM Smart App display language (case sensitive). Will default to 'en-US' if not specified
-         *
          * @default en-US
          * @enum {string}
          */
@@ -1113,7 +1094,6 @@ export interface components {
          *     Browser: https URL to your website.
          *
          *     Mobile: Universal link (your-app://) or app scheme.
-         *
          * @example https://www.yourwebsite.com/callback
          * @example com.filleasy.app
          */
@@ -1149,7 +1129,6 @@ export interface components {
          * @description Mandatorily obtain specific profile fields.
          *     Note: You must display a consent page per iAM Smart UI/UX requirements when using these fields.
          *     If fields overlap between `profileFields` and `formData.formFields`, `profileFields` takes precedence.
-         *
          * @example [
          *       "idNo",
          *       "enName",
@@ -1175,7 +1154,6 @@ export interface components {
              *     For Hong Kong: Business Registration Number (BRN) - an 8-digit number.
              *     For Australia: Australian Company Number (ACN).
              *     For Singapore: Unique Entity Number (UEN).
-             *
              * @example 72599839
              */
             companyId: string;
@@ -1185,7 +1163,6 @@ export interface components {
              *     - "ACN" - Australian Company Number (Australia)
              *     - "UEN" - Unique Entity Number (Singapore)
              *     - "Unavailable" - When the country does not provide a company ID
-             *
              * @example BRN
              */
             idType: string;
@@ -1200,7 +1177,6 @@ export interface components {
              * @description Current active status of the company.
              *     - "Live" - Company is currently active and in good standing
              *     - "Dissolved" - Company has been dissolved/deregistered
-             *
              * @example Live
              * @enum {string}
              */
@@ -1209,27 +1185,13 @@ export interface components {
              * @description Indicates whether the returned name is the current or a previous name.
              *     - "current" - This is the company's current registered name
              *     - "old" - This is a previous/historical name of the company
-             *
              * @example current
              * @enum {string}
              */
             nameType?: "current" | "old";
-            /**
-             * @description Type of incorporation/registration based on Companies Ordinance (Cap. 622)
-             * @example Company Limited by Shares
-             * @enum {string}
-             */
-            incorporationType?: "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" | "N/A";
-            /**
-             * @description Private vs Public company classification based on Companies Ordinance (Cap. 622)
-             * @example Private Company
-             * @enum {string}
-             */
-            entityCategory?: "Public Company" | "Private Company" | "N/A";
             /** @description Registered address of the company (when available) */
             address?: string;
-        };
-        CompanyBaseData: components["schemas"]["Company"] & {
+            registrationDetails: components["schemas"]["registrationDetail"][];
             /**
              * Format: date
              * @description Date of dissolution (YYYY-MM-DD format, empty string if not dissolved)
@@ -1260,6 +1222,13 @@ export interface components {
                 effectiveDate?: string;
             }[];
         };
+        /**
+         * @description Legal classification or entity type identifier.
+         *     Provides details about a company based on its incorporation structure (e.g., Limited by Shares) or its regulatory category (e.g., Private vs. Public) according to the relevant national companies legislation.
+         * @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";
     };
     responses: {
         /** @description Unauthorized - Token is missing, invalid, or expired */
@@ -1339,9 +1308,10 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Authentication request successfully initialized.
+            /**
+             * @description Authentication request successfully initialized.
              *     Store the token for subsequent API calls.
-             *      */
+             */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -1354,7 +1324,6 @@ export interface operations {
                          * Format: uri
                          * @description Browser: URL to iAM Smart QR page for scanning.
                          *     Mobile: Universal link to launch iAM Smart app.
-                         *
                          * @example https://hk.gov.iamsmart.testapp://auth?clientID=...
                          */
                         url: string;
@@ -1385,9 +1354,10 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Form filling request successfully initialized.
+            /**
+             * @description Form filling request successfully initialized.
              *     Poll with the returned token to retrieve form data when ready.
-             *      */
+             */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -1441,9 +1411,10 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Signing request successfully initialized.
+            /**
+             * @description Signing request successfully initialized.
              *     Poll with the returned token to get signature results.
-             *      */
+             */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -1502,9 +1473,10 @@ export interface operations {
             };
         };
         responses: {
-            /** @description PDF signing request successfully initialized.
+            /**
+             * @description PDF signing request successfully initialized.
              *     Poll with the returned token to retrieve signed PDF when ready.
-             *      */
+             */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -1543,9 +1515,10 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Re-authentication request successfully initialized.
+            /**
+             * @description Re-authentication request successfully initialized.
              *     Poll with the returned token to get re-authentication results.
-             *      */
+             */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -1607,9 +1580,10 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Anonymous form filling request successfully initialized.
+            /**
+             * @description Anonymous form filling request successfully initialized.
              *     Redirect user to the URL, then poll with the token to retrieve form data.
-             *      */
+             */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -1658,9 +1632,10 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Anonymous signing request successfully initialized.
+            /**
+             * @description Anonymous signing request successfully initialized.
              *     Redirect user to the URL, then poll with the token to retrieve signature.
-             *      */
+             */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -2141,9 +2116,11 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    /** @example {
+                    /**
+                     * @example {
                      *       "message": "Invalid request body"
-                     *     } */
+                     *     }
+                     */
                     "application/json": {
                         /** @enum {string} */
                         message?: "Invalid request body";
@@ -2156,9 +2133,11 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    /** @example {
+                    /**
+                     * @example {
                      *       "message": "Unauthorized"
-                     *     } */
+                     *     }
+                     */
                     "application/json": {
                         /** @enum {string} */
                         message?: "Unauthorized";
@@ -2274,7 +2253,6 @@ export interface operations {
                      * Format: uri
                      * @description Where to redirect the user **after success**.
                      *     Must be publicly reachable over **https**.
-                     *
                      * @example https://example.com/ocr/complete
                      */
                     completeCallbackUrl: string;
@@ -2282,7 +2260,6 @@ export interface operations {
                      * 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;
@@ -2290,7 +2267,6 @@ export interface operations {
                      * @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}
                      */
@@ -2310,13 +2286,13 @@ export interface operations {
                          * 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.
+                        /**
+                         * @description JWT token carrying bizId and transactionId.
                          *     Store this token to poll for verification results using `/ocr/poll`.
-                         *      */
+                         */
                         token: components["schemas"]["Token"];
                     };
                 };
@@ -2866,20 +2842,13 @@ export interface operations {
                     };
                 };
             };
-            /** @description Bad Request - Invalid input parameters */
+            /** @description Bad Request - Invalid input parameters, or service not offered for this country */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description No matching companies found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
             /** @description Internal server error */
             500: {
                 headers: {
@@ -2955,20 +2924,13 @@ export interface operations {
                     };
                 };
             };
-            /** @description Bad Request - Invalid input parameters */
+            /** @description Bad Request - Invalid input parameters, or service not offered for this country */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description No documents found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
             /** @description Internal server error */
             500: {
                 headers: {
@@ -3009,25 +2971,18 @@ export interface operations {
                          * @enum {string}
                          */
                         message: "success" | "search error";
-                        /** @description Company base information object */
-                        result?: components["schemas"]["CompanyBaseData"];
+                        /** @description Company base information object or null if not found */
+                        result?: components["schemas"]["Company"] | null;
                     };
                 };
             };
-            /** @description Bad Request - Invalid input parameters */
+            /** @description Bad Request - Invalid input parameters, or service not offered for this country */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description Company not found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
             /** @description Internal server error */
             500: {
                 headers: {
@@ -3053,7 +3008,6 @@ export interface operations {
                      *     It queries the scopes required for accessing the resources or services in question.
                      *     Available scopes: sub, fullnameAR, gender, mobile, lastnameEN, fullnameEN, uuid, lastnameAR, idn, nationalityEN, firstnameEN, userType, nationalityAR, firstnameAR, email.
                      *     (To be shared by UAEPASS Team if its value is other than specified in sample above)
-                     *
                      * @example sub fullnameEN email mobile
                      */
                     scope?: string;

package/package.json

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