@fill-easy/api 1.0.33 → 1.0.35

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
@@ -3022,8 +3066,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 */

package/package.json

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