squarefi-bff-api-module 1.36.65 → 1.36.66

package/dist/api/types/autogen/apiV1Frontend.types.d.ts

@@ -11257,7 +11257,7 @@ export interface paths {
          *     Each wallet includes `access_role` (owner/admin/user/auditor) and `is_owner` boolean.
          *
          *     Wallets where the caller holds the scoped `user` role are returned as a reduced shell
-         *     (`uuid`, `name`, `display_name`, `tenant_id`, `kyc_info`, `created_at` + the role fields) — no `logo_url`.
+         *     (`uuid`, `name`, `display_name`, `tenant_id`, `kyc_entity_id`, `kyc_info`, `created_at` + the role fields) — no `logo_url`.
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
@@ -11323,20 +11323,18 @@ export interface paths {
                                 access_role: "owner" | "admin" | "user" | "auditor";
                                 /** @description True if user is the wallet owner */
                                 is_owner: boolean;
+                                /**
+                                 * Format: uuid
+                                 * @description KYC entity the wallet was opened for (`GET /kyc/entities`) — group the
+                                 *     list by it to see which accounts an entity already has. `null` for a
+                                 *     wallet created without one.
+                                 *
+                                 */
+                                kyc_entity_id: string | null;
                                 /** @description KYC entity attached to the wallet (joined from `kyc_entity`).
                                  *     `null` when the wallet has no KYC entity yet.
                                  *      */
-                                kyc_info: {
-                                    /** @description KYC entity type (e.g. INDIVIDUAL, BUSINESS) */
-                                    type: string;
-                                    /** @description KYC verification status (e.g. UNVERIFIED, PENDING, APPROVED, REJECTED) */
-                                    status: string;
-                                    business_name: string | null;
-                                    first_name: string | null;
-                                    last_name: string | null;
-                                    email: string | null;
-                                    phone: string | null;
-                                } | null;
+                                kyc_info: components["schemas"]["WalletKycInfo"] | null;
                             }[];
                             pagination: {
                                 offset: number;
@@ -11373,6 +11371,10 @@ export interface paths {
          *       - `empty_name: false` or omitted (default) → a random placeholder name
          *         is generated (e.g., "Golden Vault 42").
          *       - `empty_name: true` → the wallet is created with `name: null`.
+         *     - **purpose** — what the account is opened for, one of the listed codes.
+         *       `other` needs a free-text **purpose_other**; any other code refuses it.
+         *       Stored once with the wallet: it cannot be changed later and no
+         *       endpoint returns it.
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
@@ -11410,6 +11412,21 @@ export interface paths {
                          *
                          */
                         kyc_entity_id?: string;
+                        /**
+                         * @description What the account is opened for. Only the code travels — labels
+                         *     are the client's. Write-once and never returned.
+                         *
+                         * @example payroll
+                         * @enum {string}
+                         */
+                        purpose?: "payroll" | "client_or_project_funds" | "treasury_or_reserves" | "separate_by_team" | "separate_by_currency_or_region" | "other";
+                        /**
+                         * @description Free-text purpose. Required when `purpose` is `other`, refused
+                         *     with any other `purpose` (a blank value counts as absent).
+                         *
+                         * @example Contractor payouts
+                         */
+                        purpose_other?: string | null;
                     };
                 };
             };
@@ -11438,25 +11455,22 @@ export interface paths {
                                 tenant_id: string;
                                 /** Format: date-time */
                                 created_at: string;
+                                /**
+                                 * Format: uuid
+                                 * @description KYC entity the wallet was opened for. `null` for a wallet created without one.
+                                 */
+                                kyc_entity_id: string | null;
                                 /** @description Mirrors the GET-wallet shape. `null` when the wallet was created
                                  *     without `kyc_entity_id`; populated with the linked entity otherwise.
                                  *      */
-                                kyc_info: {
-                                    type: string;
-                                    status: string;
-                                    business_name: string | null;
-                                    first_name: string | null;
-                                    last_name: string | null;
-                                    email: string | null;
-                                    phone: string | null;
-                                } | null;
+                                kyc_info: components["schemas"]["WalletKycInfo"] | null;
                             };
                             /** @example Wallet created successfully */
                             message: string;
                         };
                     };
                 };
-                /** @description Bad request — invalid name, or `kyc_entity_id` is malformed / not an entity of the current user / belongs to another tenant */
+                /** @description Bad request — invalid name; `kyc_entity_id` is malformed / not an entity of the current user / belongs to another tenant; `purpose` is not a listed code; `purpose_other` is missing for `other`, longer than 255 characters or sent with another `purpose` */
                 400: {
                     headers: {
                         [name: string]: unknown;
@@ -11670,7 +11684,7 @@ export interface paths {
          *     - `owner` / `admin` / `auditor` — the full wallet (`WalletDetails`): identity, KYC, `balance`,
          *       `fiat_accounts`, `base_currency` and the totals.
          *     - `user` — a shell-only wallet (`WalletDetailsScopedUser`): `uuid`, `id`, `name`, `display_name`,
-         *       `tenant_id`, `kyc_info`, `created_at` + the role fields. `logo_url`, `balance`, `fiat_accounts`,
+         *       `tenant_id`, `kyc_entity_id`, `kyc_info`, `created_at` + the role fields. `logo_url`, `balance`, `fiat_accounts`,
          *       `base_currency`, `fiat_total`, `crypto_total`, `pending_balance` and `total_amount` are absent
          *       (not null) for that role — check `access_role` before reading them.
          *
@@ -11788,18 +11802,15 @@ export interface paths {
                                 tenant_id: string;
                                 /** Format: date-time */
                                 created_at: string;
+                                /**
+                                 * Format: uuid
+                                 * @description KYC entity the wallet was opened for. `null` for a wallet created without one.
+                                 */
+                                kyc_entity_id: string | null;
                                 /** @description KYC entity attached to the wallet (joined from `kyc_entity`).
                                  *     `null` when the wallet has no KYC entity yet.
                                  *      */
-                                kyc_info: {
-                                    type: string;
-                                    status: string;
-                                    business_name: string | null;
-                                    first_name: string | null;
-                                    last_name: string | null;
-                                    email: string | null;
-                                    phone: string | null;
-                                } | null;
+                                kyc_info: components["schemas"]["WalletKycInfo"] | null;
                             };
                             /** @example Wallet updated successfully */
                             message: string;
@@ -15093,8 +15104,16 @@ export interface components {
         };
         /** @description KYC entity attached to the wallet. `null` when the wallet has no KYC entity yet. */
         WalletKycInfo: {
-            type: string;
-            status: string;
+            /**
+             * @description KYC entity type, lower-case.
+             * @enum {string}
+             */
+            type: "individual" | "business" | "universal";
+            /**
+             * @description KYC verification status. A refusal is one of three values: `DECLINED`, `REJECT` or `SOFT_REJECT`. Only `APPROVED` (full access) and `HOLD` (read-only) open the wallet.
+             * @enum {string}
+             */
+            status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
             business_name: string | null;
             first_name: string | null;
             last_name: string | null;
@@ -15130,6 +15149,11 @@ export interface components {
             tenant_id: string;
             /** Format: date-time */
             created_at: string;
+            /**
+             * Format: uuid
+             * @description KYC entity the wallet was opened for (`GET /kyc/entities`). `null` for a wallet created without one.
+             */
+            kyc_entity_id: string | null;
             kyc_info: components["schemas"]["WalletKycInfo"] | null;
             /** @description Aggregated crypto balances */
             balance: components["schemas"]["WalletBalanceEntry"][];
@@ -15171,6 +15195,11 @@ export interface components {
             tenant_id: string;
             /** Format: date-time */
             created_at: string;
+            /**
+             * Format: uuid
+             * @description KYC entity the wallet was opened for (`GET /kyc/entities`). `null` for a wallet created without one.
+             */
+            kyc_entity_id: string | null;
             kyc_info: components["schemas"]["WalletKycInfo"] | null;
             /**
              * @description Always `user` on this shape. (enum property replaced by openapi-typescript)

package/dist/api/types/autogen/apiV2.types.d.ts

@@ -1628,6 +1628,7 @@ export interface components {
         KycEntityDto: {
             id: string;
             user_data_uuid: string;
+            created_at: string;
             /** @enum {string} */
             type: "individual" | "business" | "universal";
             id_number?: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarefi-bff-api-module",
-  "version": "1.36.65",
+  "version": "1.36.66",
   "description": "Squarefi BFF API client module",
   "type": "module",
   "main": "./dist/index.js",