squarefi-bff-api-module 1.36.33 → 1.36.34

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

@@ -6332,13 +6332,13 @@ export interface paths {
         get: {
             parameters: {
                 query?: {
-                    /** @description Filter by status (comma-separated for multi-select) */
+                    /** @description Filter by status (comma-separated for multi-select — new, pending, processing, complete, canceled, failed) */
                     status?: string;
-                    /** @description Transaction type filter */
-                    type?: string;
+                    /** @description Transaction type (direction) */
+                    type?: "deposit" | "withdrawal";
                     /** @description Transaction method filter */
-                    method?: string;
-                    /** @description Record type filter */
+                    method?: "p2p" | "crypto" | "bank_transfer" | "exchange" | "sbp" | "internal_fiat";
+                    /** @description Transaction subtype (e.g. `DEPOSIT_CRYPTO_EXTERNAL`, `CARD_PROVIDER_DEPOSIT`) */
                     record_type?: string;
                     /** @description Filter by sender or recipient address (matches `from` OR `to` fields) */
                     address?: string;

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

@@ -7657,6 +7657,208 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/frontend/user_verification/init": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Initialize user-level Sumsub verification
+         * @description Starts (or upgrades) the caller's user-level Sumsub verification via
+         *     the Auth API. The chosen `flow` maps to a tenant-configured Sumsub
+         *     level — `data` (personal information), `documents` (+identity
+         *     document) or `face` (+face check) — and the whole level is completed
+         *     as one WebSDK session. Returns the Sumsub applicant id plus a
+         *     short-lived WebSDK access token. The caller's Bearer token is
+         *     forwarded to the Auth API.
+         *
+         *     User-scoped: no wallet is involved, unlike
+         *     `/frontend/kyc_verification/{wallet_id}/init`.
+         *
+         *     **Authentication**: Bearer token with x-tenant-id header required
+         *
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * @description Verification tier to complete as one SDK session
+                         * @enum {string}
+                         */
+                        flow: "data" | "documents" | "face";
+                    };
+                };
+            };
+            responses: {
+                /** @description User verification initialized */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example true */
+                            success: boolean;
+                            data: {
+                                /**
+                                 * @description Echo of the requested flow
+                                 * @enum {string}
+                                 */
+                                flow: "data" | "documents" | "face";
+                                /** @description Sumsub applicantId */
+                                verification_id: string;
+                                /** @description Short-lived WebSDK access token — otherwise null */
+                                verification_token?: string | null;
+                            };
+                        };
+                    };
+                };
+                /** @description Validation error (`flow` missing or not in [data, documents, face]) */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Missing or invalid Bearer token */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description User verification is not enabled for the tenant (no Sumsub levels configured) */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description A concurrent init for the same user is in progress (per-user lock) */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Auth API unavailable, timed out, or returned a malformed payload */
+                502: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/frontend/user_verification/resume": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Resume user-level Sumsub verification
+         * @description Re-issues the short-lived WebSDK access token for the level the caller
+         *     is already on (the WebSDK's expirationHandler contract). The caller's
+         *     Bearer token is forwarded to the Auth API.
+         *
+         *     **Authentication**: Bearer token with x-tenant-id header required
+         *
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description User verification resumed */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example true */
+                            success: boolean;
+                            data: {
+                                /** @description Always null on resume — the Auth API resumes the current level */
+                                flow?: string | null;
+                                /** @description Sumsub applicantId */
+                                verification_id: string;
+                                /** @description Short-lived WebSDK access token — otherwise null */
+                                verification_token?: string | null;
+                            };
+                        };
+                    };
+                };
+                /** @description Missing or invalid Bearer token */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Verification not initialized for this user */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Auth API unavailable, timed out, or returned a malformed payload */
+                502: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/frontend/virtual-accounts/wallet/{wallet_id}": {
         parameters: {
             query?: never;
@@ -9556,13 +9758,13 @@ export interface paths {
                     sort_by?: string;
                     /** @description Sort direction */
                     sort_order?: "ASC" | "DESC";
-                    /** @description Comma-separated transaction statuses (e.g. complete,pending) */
+                    /** @description Comma-separated transaction statuses (new, pending, processing, complete, canceled, failed) */
                     status?: string;
-                    /** @description Transaction type filter */
-                    type?: string;
+                    /** @description Transaction type (direction) */
+                    type?: "deposit" | "withdrawal";
                     /** @description Transaction method filter */
-                    method?: string;
-                    /** @description Record type filter */
+                    method?: "p2p" | "crypto" | "bank_transfer" | "exchange" | "sbp" | "internal_fiat";
+                    /** @description Transaction subtype (e.g. `DEPOSIT_CRYPTO_EXTERNAL`, `CARD_PROVIDER_DEPOSIT`) */
                     record_type?: string;
                     /** @description Filter by sender or recipient address (matches `from` OR `to` fields) */
                     address?: string;
@@ -9662,13 +9864,13 @@ export interface paths {
         get: {
             parameters: {
                 query?: {
-                    /** @description Filter by status (comma-separated for multi-select, e.g. `completed,pending`) */
+                    /** @description Filter by status (comma-separated for multi-select — new, pending, processing, complete, canceled, failed) */
                     status?: string;
-                    /** @description Transaction type filter */
-                    type?: string;
+                    /** @description Transaction type (direction) */
+                    type?: "deposit" | "withdrawal";
                     /** @description Transaction method filter */
-                    method?: string;
-                    /** @description Record type filter */
+                    method?: "p2p" | "crypto" | "bank_transfer" | "exchange" | "sbp" | "internal_fiat";
+                    /** @description Transaction subtype (e.g. `DEPOSIT_CRYPTO_EXTERNAL`, `CARD_PROVIDER_DEPOSIT`) */
                     record_type?: string;
                     /** @description Filter by sender or recipient address (matches `from` OR `to` fields) */
                     address?: string;
@@ -9874,6 +10076,13 @@ export interface paths {
                                     first_name?: string;
                                     last_name?: string;
                                     logo_url?: string;
+                                    /**
+                                     * @description Outcome of the member's Sumsub IDENTITY-document step.
+                                     *     `APPROVED` is the only value that permits issuing a card to this member.
+                                     *
+                                     * @enum {string}
+                                     */
+                                    identity_verification_status?: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
                                 };
                             }[];
                             pagination?: components["schemas"]["PaginationResponse"];

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

@@ -8035,27 +8035,70 @@ export interface components {
                 country?: string | null;
             };
         };
-        /** @description Bank account information of the sender */
+        /** @description Bank account information of the sender.
+         *
+         *     Every key below is always present; a value the payment rail did not
+         *     provide is an empty string. Identifiers are placed by what the value
+         *     IS, not by what the rail called it: an IBAN is always in `iban` (never
+         *     in `account_number`) and a SWIFT/BIC is always in `swift_bic` (never in
+         *     `routing_number`), including for orders created before this became the
+         *     case. So `account_number` and `routing_number` carry domestic
+         *     identifiers only.
+         *      */
         L2FOriginatorAccountInfo: {
             /**
-             * @description Bank account number
+             * @description Domestic bank account number. Empty when the sender's identifier is an IBAN.
              * @example 202504243736
              */
             account_number?: string;
             /**
-             * @description Routing number (for US payments)
+             * @description Domestic routing number (US ABA and equivalents). Empty when the value is a BIC.
              * @example 91311229
              */
             routing_number?: string | null;
-            /** @description SWIFT BIC code (for international transfers) */
+            /**
+             * @description Sender's IBAN, for SEPA and SWIFT payments.
+             * @example CZ6508000000192000145399
+             */
+            iban?: string | null;
+            /**
+             * @description SWIFT BIC code of the sender's bank (for international transfers)
+             * @example FIOBCZPPXXX
+             */
             swift_bic?: string | null;
-            /** @description Name of the bank/institution */
+            /**
+             * @description Sort code of the sender's bank (UK payments)
+             * @example 60-16-13
+             */
+            sort_code?: string | null;
+            /**
+             * @description Currency of the sender's account, when the rail reports it
+             * @example EUR
+             */
+            currency_code?: string | null;
+            /**
+             * @description Name of the sender's bank. Often empty — several rails do not report
+             *     it, and a value that merely repeats the sender's own name is omitted
+             *     rather than presented as a bank.
+             *
+             * @example Fio banka, a.s.
+             */
             institution_name?: string | null;
+            /**
+             * @description Correspondent/intermediary bank, when the payment was routed through one
+             * @example SSB PITTSBURGH
+             */
+            intermediary_institution_name?: string | null;
         };
         /**
-         * @description Standardized originator (sender) information for L2F ONRAMP orders.
-         *     Available for order types: L2F_ACH_ONRAMP, L2F_WIRE_ONRAMP, L2F_SEPA_ONRAMP, L2F_SWIFT_ONRAMP.
-         *     This field appears in order.meta.originator
+         * @description Standardized originator (sender) information for incoming fiat payments,
+         *     exposed as `order.meta.originator`.
+         *
+         *     The shape is the same whichever rail carried the payment — L2F, Brale,
+         *     BCB or Delos onramps all normalize into it. Sender details come from the
+         *     paying bank, so how much is populated varies by rail and by payment:
+         *     `profile.name` is almost always present, while the sender's address is
+         *     rarely reported and is often empty for every field.
          *
          * @example {
          *       "profile": {
@@ -8071,8 +8114,12 @@ export interface components {
          *       "account_information": {
          *         "account_number": "202504243736",
          *         "routing_number": "91311229",
+         *         "iban": "",
          *         "swift_bic": "",
-         *         "institution_name": ""
+         *         "sort_code": "",
+         *         "currency_code": "USD",
+         *         "institution_name": "JPMorgan Chase",
+         *         "intermediary_institution_name": ""
          *       },
          *       "reference": "20251016MMQFMP2U004005",
          *       "memo": "bfgkp5w"
@@ -8080,7 +8127,20 @@ export interface components {
          */
         L2FOriginator: {
             profile?: components["schemas"]["L2FOriginatorProfile"];
+            /** @description Sender's bank details. Present on incoming fiat payments only —
+             *     an internal transfer carries `wallet_information` instead.
+             *      */
             account_information?: components["schemas"]["L2FOriginatorAccountInfo"];
+            /** @description Sending wallet, in place of `account_information` when the funds
+             *     came from another wallet on the platform rather than from a bank.
+             *      */
+            wallet_information?: {
+                /** Format: uuid */
+                wallet_uuid?: string;
+                wallet_name?: string;
+                /** @description Source address for a crypto transfer; null for an internal balance transfer */
+                crypto_address?: string | null;
+            } | null;
             /**
              * @description Payment reference number (rail_reference from Railio)
              * @example 20251016MMQFMP2U004005
@@ -8092,6 +8152,36 @@ export interface components {
              */
             memo?: string | null;
         } | null;
+        /**
+         * @description Same shape for an inbound SWIFT payment: the sender is identified by an
+         *     IBAN and a BIC, so the domestic fields stay empty.
+         *
+         * @example {
+         *       "profile": {
+         *         "name": "Giovanni Belfiore",
+         *         "address": {
+         *           "address_line1": "",
+         *           "city": "",
+         *           "state": "",
+         *           "postal_code": "",
+         *           "country": ""
+         *         }
+         *       },
+         *       "account_information": {
+         *         "account_number": "",
+         *         "routing_number": "",
+         *         "iban": "CZ6508000000192000145399",
+         *         "swift_bic": "FIOBCZPPXXX",
+         *         "sort_code": "",
+         *         "currency_code": "USD",
+         *         "institution_name": "",
+         *         "intermediary_institution_name": ""
+         *       },
+         *       "reference": "5pdbjv4ev351",
+         *       "memo": "Fee for services"
+         *     }
+         */
+        L2FOriginatorSwiftExample: components["schemas"]["L2FOriginator"];
         /**
          * @description Optional array of document objects to attach to the order.
          *     Documents should be uploaded to a storage service beforehand and only URLs should be provided.

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

@@ -1020,17 +1020,17 @@ export interface components {
              * @default UNVERIFIED
              * @enum {string|null}
              */
-            kyc_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW" | null;
+            kyc_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW" | null;
             /**
              * @default UNVERIFIED
              * @enum {string}
              */
-            identity_verification_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
+            identity_verification_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
             /**
              * @default UNVERIFIED
              * @enum {string}
              */
-            face_verification_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
+            face_verification_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
             readonly profile_source: string | null;
             readonly profile_synced_at: string | null;
             referral_name: string | null;
@@ -1306,7 +1306,7 @@ export interface components {
              * @default UNVERIFIED
              * @enum {string}
              */
-            status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
+            status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
             readonly business_name?: string;
             readonly first_name?: string;
             readonly last_name?: string;
@@ -1689,7 +1689,7 @@ export interface components {
              * @default UNVERIFIED
              * @enum {string}
              */
-            status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
+            status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
             /** @enum {string|null} */
             employment_status?: "EMPLOYEE" | "SELF_EMPLOYED" | "RETIRED" | "UNEMPLOYED" | "STUDENT" | "OTHER" | null;
             employment_description?: string | null;
@@ -1761,7 +1761,7 @@ export interface components {
         WalletKycRailDto: {
             message: string | null;
             /** @enum {string} */
-            readonly status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
+            readonly status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
             /** @default false */
             terms_confirmed: boolean;
             extra_actions?: components["schemas"]["WalletKycRailExtraActionDto"][];

package/dist/constants.d.ts

@@ -285,6 +285,7 @@ export declare enum KYCStatuses {
     PENDING = "PENDING",
     PROCESSING = "PROCESSING",
     HOLD = "HOLD",
+    NEEDS_ATTENTION = "NEEDS_ATTENTION",
     DOUBLE = "DOUBLE",
     SOFT_REJECT = "SOFT_REJECT",
     REJECT = "REJECT",

package/dist/constants.js

@@ -300,6 +300,7 @@ export var KYCStatuses;
     KYCStatuses["PENDING"] = "PENDING";
     KYCStatuses["PROCESSING"] = "PROCESSING";
     KYCStatuses["HOLD"] = "HOLD";
+    KYCStatuses["NEEDS_ATTENTION"] = "NEEDS_ATTENTION";
     KYCStatuses["DOUBLE"] = "DOUBLE";
     KYCStatuses["SOFT_REJECT"] = "SOFT_REJECT";
     KYCStatuses["REJECT"] = "REJECT";

package/package.json

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