@fill-easy/api 1.0.29 → 1.0.31

package/dist/openapi.d.ts

@@ -649,6 +649,99 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/uaepass/request/auth": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Authentication
+         * @description Retrieves user identity details following a successful UAE Pass login.
+         */
+        post: operations["uaepassAuth"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/uaepass/poll": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Poll Data
+         * @description Short poll this endpoint, passing in the `token` (from endpoints in `Request Data` folder) to obtain the results.
+         *
+         *     For authentication, this includes user data. For signing, this provides a link by which the signed document can be obtained.
+         *
+         *     The response's `token` is a JWT or JWE depending if there's sensitive personal data. You should handle them like so:
+         *
+         *     - `JWT` verify\* token
+         *
+         *     - `JWE` decrypt using the private keys that Fill Easy has previously provided.
+         *
+         *
+         *     Please note that the data result is returned only once and is deleted immediately.
+         *
+         *     \*you can try using online decoder like [https://jwt.io/](https://jwt.io/)
+         *
+         *     all responses are `JWE` unless noted otherwise.
+         */
+        post: operations["uaepassPoll"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/uaepass/callback": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Callback
+         * @description UAE Pass will redirect to this endpoint after user authorization.
+         *     This endpoint then redirects the user again to the original `redirect` URI provided in the `/uaepass/request/auth` request, appending the authorization `code` and `state` as query parameters.
+         */
+        get: operations["uaepassCallback"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/uaepass/logout": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** UAEPass Logout */
+        post: operations["uaepassLogout"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/ocr/request": {
         parameters: {
             query?: never;
@@ -878,30 +971,15 @@ export interface paths {
         put?: never;
         /**
          * Request
-         * @description This endpoint may retrieve the company JSON and document via two methods:
-         *
-         *     For a full list of Country Coverage, please check out /readme .
-         *
-         *     #### Automated retrieval using Company ID for supported countries
+         * @description Initiate a company report request. Returns a JWT token for use with `/cra/poll`.
          *
-         *     If the country supplied in `countryCode` is automated according to Country Coverage table,
-         *     and the supplied `companyId` is valid, the system will automatically fetch the document.
+         *     **Required:** `countryCode` (ISO 3166 alpha-2)
          *
-         *     In order to ensure a valid `companyId`, please validate using `/cra/{countryCode}/search/companies`.
+         *     **Recommended:** `companyId` from `/cra/{countryCode}/search/companies` for faster automated processing.
          *
-         *     In this case, `/cra/poll` will resolve in around 5 minutes.
+         *     **Fallback:** Provide `companyName` if `companyId` is unavailable — request will be processed manually.
          *
-         *     The `/cra/{countryCode}/search/companies` endpoint will not return a
-         *     companyId for certain countries (empty string). In that case please
-         *     refer to the information in the section below.
-         *
-         *     #### Manual request for unsupported countries or missing Company ID
-         *
-         *     In case of unsupported countries or missing `companyId`, Fill Easy will manually process the request.
-         *     Retrieving this information may take longer (up to several days).
-         *
-         *     In any case, the endpoint returns a JWT token that should be used with the
-         *     `/cra/poll` endpoint to retrieve the document when ready.
+         *     **Document Request:** Provide `documentId` from `/cra/{countryCode}/search/documents` to request specific document.
          */
         post: operations["craRequest"];
         delete?: never;
@@ -1048,87 +1126,13 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get CRA Country Information
-         * @description Returns metadata and a list of all countries supported by the CRA service,
+         * 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.
-         */
-        get: operations["craInfo"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/uaepass/request/auth": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Authentication
-         * @description Retrieves user identity details following a successful UAE Pass login.
-         */
-        post: operations["uaepassAuth"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/uaepass/poll": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Poll Data
-         * @description Short poll this endpoint, passing in the `token` (from endpoints in `Request Data` folder) to obtain the results.
-         *
-         *     For authentication, this includes user data. For signing, this provides a link by which the signed document can be obtained.
-         *
-         *     The response's `token` is a JWT or JWE depending if there's sensitive personal data. You should handle them like so:
-         *
-         *     - `JWT` verify\* token
-         *
-         *     - `JWE` decrypt using the private keys that Fill Easy has previously provided.
-         *
-         *
-         *     Please note that the data result is returned only once and is deleted immediately.
          *
-         *     \*you can try using online decoder like [https://jwt.io/](https://jwt.io/)
-         *
-         *     all responses are `JWE` unless noted otherwise.
-         */
-        post: operations["uaepassPoll"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/uaepass/callback": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Callback
-         * @description UAE Pass will redirect to this endpoint after user authorization.
-         *     This endpoint then redirects the user again to the original `redirect` URI provided in the `/uaepass/request/auth` request, appending the authorization `code` and `state` as query parameters.
+         *     > For an up-to-date version of the same data, please view the [CorpVerify Country Coverage table](countries).
          */
-        get: operations["uaepassCallback"];
+        get: operations["craInfo"];
         put?: never;
         post?: never;
         delete?: never;
@@ -1137,23 +1141,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/uaepass/logout": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /** UAEPass Logout */
-        post: operations["uaepassLogout"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/lra/request": {
         parameters: {
             query?: never;
@@ -1261,6 +1248,13 @@ export interface components {
                 financial: boolean;
             };
         };
+        CraInvalidCountryError: {
+            /**
+             * @description Error message indicating the country code is invalid or the service is not offered
+             * @example Invalid countryCode / Service not offered for countryCode: XX
+             */
+            message: string;
+        };
         Error: {
             /**
              * @description Error message
@@ -2446,6 +2440,143 @@ export interface operations {
             };
         };
     };
+    uaepassAuth: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    redirect: components["schemas"]["RedirectUri"];
+                    /**
+                     * @description List of values, separated by spaces, that represent the scope of the authorization that the application wants to obtain.
+                     *     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;
+                    /**
+                     * @description UAE Pass display language, case sensitive
+                     * @example en
+                     * @enum {string}
+                     */
+                    lang?: "en" | "ar";
+                    /**
+                     * @description Platform source for the authentication request
+                     * @example PC_Browser
+                     * @enum {string}
+                     */
+                    source: "PC_Browser" | "android" | "iOS" | "Mobile_Browser";
+                };
+            };
+        };
+        responses: {
+            /** @description Success */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description JWT token for polling authentication status */
+                        token: string;
+                        /**
+                         * Format: uri
+                         * @description UAE Pass authorization URL to redirect user to
+                         */
+                        oAuthUrl: string;
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    uaepassPoll: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    token: components["schemas"]["Token"];
+                };
+            };
+        };
+        responses: {
+            /** @description Success */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        message?: string;
+                        token?: components["schemas"]["Token"];
+                    };
+                };
+            };
+        };
+    };
+    uaepassCallback: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Success */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    uaepassLogout: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    redirect: components["schemas"]["RedirectUri"];
+                };
+            };
+        };
+        responses: {
+            /** @description Success */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uri
+                         * @description UAE Pass logout URL to redirect user to
+                         */
+                        logoutUrl: string;
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
     request1: {
         parameters: {
             query?: never;
@@ -3269,12 +3400,14 @@ export interface operations {
                     };
                 };
             };
-            /** @description Bad Request - Invalid input parameters */
+            /** @description Bad Request - Invalid or unsupported country code */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["CraInvalidCountryError"];
+                };
             };
             /** @description Internal server error */
             500: {
@@ -3557,12 +3690,14 @@ export interface operations {
                     };
                 };
             };
-            /** @description Bad Request - Invalid input parameters, or service not offered for this country */
+            /** @description Bad Request - Invalid or unsupported country code */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["CraInvalidCountryError"];
+                };
             };
             /** @description Internal server error */
             500: {
@@ -3641,12 +3776,14 @@ export interface operations {
                     };
                 };
             };
-            /** @description Bad Request - Invalid input parameters, or service not offered for this country */
+            /** @description Bad Request - Invalid or unsupported country code */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["CraInvalidCountryError"];
+                };
             };
             /** @description Internal server error */
             500: {
@@ -3693,12 +3830,14 @@ export interface operations {
                     };
                 };
             };
-            /** @description Bad Request - Invalid input parameters, or service not offered for this country */
+            /** @description Bad Request - Invalid or unsupported country code */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["CraInvalidCountryError"];
+                };
             };
             /** @description Internal server error */
             500: {
@@ -3718,7 +3857,7 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Successfully retrieved CRA country information */
+            /** @description Successfully retrieved country information */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -3755,143 +3894,6 @@ export interface operations {
             };
         };
     };
-    uaepassAuth: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": {
-                    redirect: components["schemas"]["RedirectUri"];
-                    /**
-                     * @description List of values, separated by spaces, that represent the scope of the authorization that the application wants to obtain.
-                     *     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;
-                    /**
-                     * @description UAE Pass display language, case sensitive
-                     * @example en
-                     * @enum {string}
-                     */
-                    lang?: "en" | "ar";
-                    /**
-                     * @description Platform source for the authentication request
-                     * @example PC_Browser
-                     * @enum {string}
-                     */
-                    source: "PC_Browser" | "android" | "iOS" | "Mobile_Browser";
-                };
-            };
-        };
-        responses: {
-            /** @description Success */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        /** @description JWT token for polling authentication status */
-                        token: string;
-                        /**
-                         * Format: uri
-                         * @description UAE Pass authorization URL to redirect user to
-                         */
-                        oAuthUrl: string;
-                    };
-                };
-            };
-            400: components["responses"]["BadRequest"];
-            500: components["responses"]["InternalServerError"];
-        };
-    };
-    uaepassPoll: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": {
-                    token: components["schemas"]["Token"];
-                };
-            };
-        };
-        responses: {
-            /** @description Success */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        message?: string;
-                        token?: components["schemas"]["Token"];
-                    };
-                };
-            };
-        };
-    };
-    uaepassCallback: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Success */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
-    uaepassLogout: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": {
-                    redirect: components["schemas"]["RedirectUri"];
-                };
-            };
-        };
-        responses: {
-            /** @description Success */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        /**
-                         * Format: uri
-                         * @description UAE Pass logout URL to redirect user to
-                         */
-                        logoutUrl: string;
-                    };
-                };
-            };
-            400: components["responses"]["BadRequest"];
-            500: components["responses"]["InternalServerError"];
-        };
-    };
     lraRequest: {
         parameters: {
             query?: never;

package/package.json

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