squarefi-bff-api-module 1.36.95 → 1.36.97

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

@@ -2976,7 +2976,7 @@ export interface components {
          * @example EXCHANGE_OMNI
          * @enum {string}
          */
-        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "RPP_SWIFT_OFFRAMP" | "RPP_SEPA_OFFRAMP" | "RPP_FPS_OFFRAMP" | "RPP_ACH_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE" | "MONTHLY_FEE" | "REFERRAL_PAYOUT";
+        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_FEDNOW_ONRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "RPP_SWIFT_OFFRAMP" | "RPP_SEPA_OFFRAMP" | "RPP_FPS_OFFRAMP" | "RPP_ACH_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE" | "MONTHLY_FEE" | "REFERRAL_PAYOUT";
         OrderCalculation: {
             /**
              * Format: uuid
@@ -3159,7 +3159,7 @@ export interface components {
              * @description Payment method associated with this order type
              * @enum {string|null}
              */
-            payment_method?: "FEDWIRE" | "ACH" | "RTP" | "SWIFT" | "SEPA" | "CHAPS" | "FPS" | "CRYPTO_EXTERNAL" | "CRYPTO_INTERNAL" | "CARD" | null;
+            payment_method?: "FEDWIRE" | "ACH" | "RTP" | "FEDNOW" | "SWIFT" | "SEPA" | "CHAPS" | "FPS" | "CRYPTO_EXTERNAL" | "CRYPTO_INTERNAL" | "CARD" | null;
             /**
              * Format: uuid
              * @description Associated KYC rail configuration ID
@@ -3468,7 +3468,10 @@ export interface components {
             vendor_card_id?: string;
             /** @description Vendor's sub-account ID */
             vendor_sub_account_id?: string | null;
-            /** @description Reason for transaction failure (empty if successful) */
+            /**
+             * @description Neutral decline reason derived from the decline code ('Declined' when no specific reason applies), never the card issuer's own text; empty if successful
+             * @example Insufficient funds
+             */
             failure_reason?: string;
             /**
              * @description Transaction status

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

@@ -345,6 +345,7 @@ export interface paths {
             requestBody: {
                 content: {
                     "application/json": {
+                        /** @description Legal name. Latin characters only (printable ASCII - letters A-Z without diacritics, digits, spaces, punctuation); anything else is refused with `400 VALIDATION_ERROR`. Transliterate other scripts before sending. */
                         name: string;
                         /** @enum {string} */
                         type: "BUSINESS" | "INDIVIDUAL";
@@ -378,12 +379,32 @@ export interface paths {
                         };
                     };
                 };
-                /** @description Validation error */
+                /** @description `VALIDATION_ERROR`: `name` or `type` missing or invalid, or `name` has characters outside printable ASCII (the message names the field) */
                 400: {
                     headers: {
                         [name: string]: unknown;
                     };
-                    content?: never;
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description `WALLET_ACCESS_DENIED`: the wallet does not belong to the tenant of the key */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description `WALLET_NOT_FOUND` */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
                 };
             };
         };
@@ -576,7 +597,8 @@ export interface paths {
          * @description counterparty_account_id is required in the body.
          *
          *     **Banking types** (ACH, SWIFT, SEPA, CHAPS, FPS, FEDWIRE):
-         *     banking_data: { account_number, routing_number, bank_name, swift_bic, iban, sort_code, note, address }
+         *     banking_data: { account_number, routing_number, bank_name, swift_bic, intermediary_bic, iban, sort_code, note, address }
+         *     — `intermediary_bic` is optional and accepted on SWIFT only.
          *
          *     **Crypto types** (CRYPTO_EXTERNAL, CRYPTO_INTERNAL):
          *     crypto_data: { address, currency_id, memo }
@@ -599,12 +621,15 @@ export interface paths {
                         counterparty_account_id: string;
                         /** @enum {string} */
                         type: "ACH" | "SWIFT" | "SEPA" | "CRYPTO_EXTERNAL" | "CRYPTO_INTERNAL" | "CHAPS" | "FPS" | "FEDWIRE" | "INTERNAL";
+                        /** @description User-friendly alias for this destination. Latin characters only (printable ASCII - letters A-Z without diacritics, digits, spaces, punctuation); anything else is refused with `400 VALIDATION_ERROR`. */
                         nickname?: string;
                         banking_data?: {
                             account_number?: string;
                             routing_number?: string;
                             bank_name?: string;
                             swift_bic?: string;
+                            /** @description BIC of the intermediary (correspondent) bank, SWIFT payment method only; 8 or 11 characters, ISO 9362 */
+                            intermediary_bic?: string | null;
                             iban?: string;
                             /** @description Sort code (6 digits, UK banking) */
                             sort_code?: string;
@@ -662,7 +687,7 @@ export interface paths {
                         };
                     };
                 };
-                /** @description Validation error. Bank-details problems come as `VALIDATION_ERROR` with every problem in `error.details.issues` (`field`, `code`, `message`, optional `country` / `detected`).
+                /** @description Validation error. Bank-details problems come as `VALIDATION_ERROR` with every problem in `error.details.issues` (`field`, `code`, `message`, optional `country` / `detected`). A `nickname` with characters outside printable ASCII is refused with `VALIDATION_ERROR` too; the message names the field.
                  *
                  *     **Until 2026-10-12 00:00 UTC** the stricter bank-details rules (per-country IBAN checks, SEPA-zone IBAN, BIC details, ABA check digit, account formats) are reported by `POST /admin/counterparty/destinations/validate` but do not refuse this request; from then on they do.
                  *      */
@@ -670,7 +695,9 @@ export interface paths {
                     headers: {
                         [name: string]: unknown;
                     };
-                    content?: never;
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
                 };
                 /** @description Account not found */
                 404: {
@@ -784,6 +811,7 @@ export interface paths {
             requestBody: {
                 content: {
                     "application/json": {
+                        /** @description User-friendly alias for this destination. Latin characters only (printable ASCII - letters A-Z without diacritics, digits, spaces, punctuation); anything else is refused with `400 VALIDATION_ERROR`. */
                         nickname?: string;
                     };
                 };
@@ -804,6 +832,15 @@ export interface paths {
                         };
                     };
                 };
+                /** @description `VALIDATION_ERROR`: no updatable field, or `nickname` has characters outside printable ASCII */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
                 /** @description Not found */
                 404: {
                     headers: {
@@ -1490,7 +1527,7 @@ export interface paths {
                     /** @description Filter by wallet UUID */
                     wallet_id?: string;
                     /** @description Filter by KYC status */
-                    status?: "UNVERIFIED" | "PENDING" | "WAITING_ON_REVIEW" | "WAITING_ON_UBOS" | "HOLD" | "APPROVED" | "SOFT_REJECT" | "REJECT" | "DECLINED" | "DOUBLE";
+                    status?: "UNVERIFIED" | "PENDING" | "WAITING_ON_REVIEW" | "WAITING_ON_UBOS" | "HOLD" | "APPROVED" | "SOFT_REJECT" | "REJECT" | "DECLINED" | "DOUBLE" | "EXPIRED" | "OFFBOARDED";
                     /** @description Filter by entity type */
                     type?: "individual" | "business";
                     offset?: number;
@@ -4264,14 +4301,12 @@ export interface paths {
          * List order types
          * @description Returns order types with KYC rails.
          *
-         *     - When the request is scoped to a tenant (via `x-tenant-id` header or session),
-         *       the list is **filtered** to order types enabled for that tenant —
-         *       i.e. those having a row in `tenant_order_type_rates`. Each returned item is
-         *       enriched with `tenant_rates` (`markup_percent`, `markup_fixed`, `mon_min_usd`)
-         *       and may expose product-facing guardrails such as `min_amount`,
-         *       `max_amount`, `first_party_only` and `documents_required_from_amount`.
-         *     - Without a tenant scope (admin global view), the full catalogue is returned
-         *       and `tenant_rates` is omitted.
+         *     The list is **filtered** to order types enabled for the workspace of the
+         *     API key — i.e. those having a row in `tenant_order_type_rates`. Each returned
+         *     item is enriched with `tenant_rates` (`markup_percent`, `markup_fixed`,
+         *     `mon_min_usd`) and may expose product-facing guardrails such as `min_amount`,
+         *     `max_amount`, `first_party_only` and `documents_required_from_amount`.
+         *     The workspace comes from the key only; an `x-tenant-id` header is ignored.
          *
          */
         get: {
@@ -8746,6 +8781,8 @@ export interface components {
             routing_number?: string | null;
             bank_name: string | null;
             swift_bic?: string | null;
+            /** @description BIC of the intermediary (correspondent) bank, SWIFT payment method only; 8 or 11 characters, ISO 9362 */
+            intermediary_bic?: string | null;
             iban?: string | null;
             /** @description Sort code (6 digits, UK banking) */
             sort_code?: string | null;
@@ -8896,7 +8933,7 @@ export interface components {
             /** @enum {string} */
             type?: "individual" | "business";
             /** @enum {string} */
-            status?: "UNVERIFIED" | "PENDING" | "WAITING_ON_REVIEW" | "WAITING_ON_UBOS" | "HOLD" | "APPROVED" | "SOFT_REJECT" | "REJECT" | "DECLINED" | "DOUBLE";
+            status?: "UNVERIFIED" | "PENDING" | "WAITING_ON_REVIEW" | "WAITING_ON_UBOS" | "HOLD" | "APPROVED" | "SOFT_REJECT" | "REJECT" | "DECLINED" | "DOUBLE" | "EXPIRED" | "OFFBOARDED";
             email?: string | null;
             phone?: string | null;
             first_name?: string | null;
@@ -8959,11 +8996,11 @@ export interface components {
                  */
                 ubo_id?: string | null;
                 /**
-                 * @description Who filed the document: `admin_api` — this API, `panel` — an operator, `bff` — the client application, `kyc_provider` — received from the KYC provider, `backfill` — carried over from the former `*_url` fields.
+                 * @description Who filed the document: `admin_api` — this API, `panel` — an operator, `bff` — the client application, `kyc_provider` — received from the KYC provider, `backfill` — carried over from the former `*_url` fields, `client` — uploaded by the client through a KYC form.
                  * @example admin_api
                  * @enum {string}
                  */
-                source?: "admin_api" | "panel" | "bff" | "kyc_provider" | "backfill";
+                source?: "admin_api" | "panel" | "bff" | "kyc_provider" | "backfill" | "client";
                 /**
                  * Format: uuid
                  * @description Shared by the files sent in one request (one submission).
@@ -9125,7 +9162,7 @@ export interface components {
          * @example EXCHANGE_OMNI
          * @enum {string}
          */
-        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "RPP_SWIFT_OFFRAMP" | "RPP_SEPA_OFFRAMP" | "RPP_FPS_OFFRAMP" | "RPP_ACH_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE" | "MONTHLY_FEE" | "REFERRAL_PAYOUT";
+        OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_FEDNOW_ONRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "RPP_SWIFT_OFFRAMP" | "RPP_SEPA_OFFRAMP" | "RPP_FPS_OFFRAMP" | "RPP_ACH_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE" | "MONTHLY_FEE" | "REFERRAL_PAYOUT";
         OrderCalculation: {
             /**
              * Format: uuid

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

@@ -1061,17 +1061,17 @@ export interface components {
              * @default UNVERIFIED
              * @enum {string|null}
              */
-            kyc_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "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" | "EXPIRED" | "OFFBOARDED" | null;
             /**
              * @default UNVERIFIED
              * @enum {string}
              */
-            identity_verification_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "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" | "EXPIRED" | "OFFBOARDED";
             /**
              * @default UNVERIFIED
              * @enum {string}
              */
-            face_verification_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "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" | "EXPIRED" | "OFFBOARDED";
             readonly profile_source: string | null;
             readonly profile_synced_at: string | null;
             referral_name: string | null;
@@ -1348,7 +1348,7 @@ export interface components {
              * @default UNVERIFIED
              * @enum {string}
              */
-            status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "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" | "EXPIRED" | "OFFBOARDED";
             readonly business_name?: string;
             readonly first_name?: string;
             readonly last_name?: string;
@@ -1762,7 +1762,7 @@ export interface components {
              * @default UNVERIFIED
              * @enum {string}
              */
-            status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "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" | "EXPIRED" | "OFFBOARDED";
             /** @enum {string|null} */
             employment_status?: "EMPLOYEE" | "SELF_EMPLOYED" | "RETIRED" | "UNEMPLOYED" | "STUDENT" | "OTHER" | null;
             employment_description?: string | null;
@@ -1830,7 +1830,7 @@ export interface components {
         WalletKycRailDto: {
             message: string | null;
             /** @enum {string} */
-            readonly status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "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" | "EXPIRED" | "OFFBOARDED";
             /** @default false */
             terms_confirmed: boolean;
             extra_actions?: components["schemas"]["WalletKycRailExtraActionDto"][];
@@ -2177,6 +2177,8 @@ export interface components {
             readonly supported_locales?: components["schemas"]["SupportedLocalesEntity"] | null;
             /** @enum {string} */
             auth_provider: "supabase" | "clerk";
+            /** @default false */
+            kyc_forms_enabled: boolean;
             base_currency: string;
             mass_payouts: components["schemas"]["SystemMassPayoutsConfigDto"];
             aml_check: components["schemas"]["SystemAmlCheckConfigDto"];

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

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import { APIKeyRole, CardFormFactor, CardTransactionType, CardType, CurrencyType, IssuingProgramStatus, OrderStatuses, OrderType, SortingDirection, SubAccountType } from '../../constants';
 import { components, operations, paths } from './autogen/apiV2.types';
 import { components as componentsV1Frontend, paths as pathsV1Frontend } from './autogen/apiV1Frontend.types';
@@ -874,6 +875,7 @@ export declare namespace API {
             export namespace Submit {
                 type Request = RailRoot['post']['parameters']['path'];
                 type Response = RailRoot['post']['responses'][200]['content']['application/json'];
+                type ErrorDetails = NonNullable<NonNullable<componentsV1Frontend['schemas']['WalletKycRailSubmitErrorResponse']['error']>['details']>;
             }
             export namespace ConfirmTerms {
                 type Request = TermsRoot['post']['parameters']['path'];
@@ -881,6 +883,147 @@ export declare namespace API {
             }
             export {};
         }
+        namespace KycForms {
+            type EntitiesRoot = pathsV1Frontend['/frontend/kyc/entities'];
+            type EntityRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}'];
+            type OverviewRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/overview'];
+            type EntityTargetsRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/targets'];
+            type TypeTargetsRoot = pathsV1Frontend['/frontend/kyc/targets'];
+            type FormsRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/forms'];
+            type DraftRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/forms/draft'];
+            type UploadsRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/forms/uploads'];
+            type UploadRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/forms/uploads/{upload_id}'];
+            type SubmitRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/forms/submit'];
+            type SessionRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/verification/session'];
+            type OwnerLinkRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/verification/owners/{owner_id}/link'];
+            type OwnerSessionRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/verification/owners/{owner_id}/session'];
+            type OwnerDocumentRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/verification/owners/{owner_id}/document'];
+            type OwnersInviteRoot = pathsV1Frontend['/frontend/kyc/entities/{entity_id}/verification/owners/invite'];
+            type Schemas = componentsV1Frontend['schemas'];
+            type UploadOptions = Pick<AxiosRequestConfig, 'signal' | 'timeout' | 'onUploadProgress'>;
+            export type Entity = Schemas['KycFormsEntity'];
+            export type EntityStatus = Schemas['KycFormsEntityStatus'];
+            export type EntityType = Entity['type'];
+            export type Overview = Schemas['KycFormsOverview']['data'];
+            export type Stage = Overview['stage'];
+            export type NextStep = Overview['next_step'];
+            export type WaitingOn = Overview['waiting_on'];
+            export type OverviewOwner = Overview['verification']['owners'][number];
+            export type OwnerType = OverviewOwner['type'];
+            export type OwnerRole = NonNullable<OverviewOwner['role']>;
+            export type VerificationState = Schemas['KycFormsVerificationState'];
+            export type EntityTargets = Schemas['KycFormsTargets']['data'];
+            export type TypeTargets = Schemas['KycFormsTypeTargets']['data'];
+            export type TargetForm = Schemas['KycFormsTargetForm'];
+            export type ProgramLevel = TypeTargets['programs'][number]['level'];
+            export type Form = Schemas['KycFormsForm'];
+            export type FormScope = Form['scope'];
+            export type FormSection = Form['sections'][number];
+            export type Terms = Schemas['KycFormsTerms'];
+            export type TermsItem = Terms['items'][number];
+            export type FormState = Schemas['KycFormsFormState'];
+            export type Field = Schemas['KycFormsField'];
+            export type FieldType = Field['type'];
+            export type FieldOption = NonNullable<Field['options']>[number];
+            export type LockReason = NonNullable<Field['lock_reason']>;
+            export type Condition = Schemas['KycFormsCondition'];
+            export type ConditionRule = Schemas['KycFormsConditionRule'];
+            export type ConditionAll = Schemas['KycFormsConditionAll'];
+            export type ConditionAny = Schemas['KycFormsConditionAny'];
+            export type ConditionOp = ConditionRule['op'];
+            export type Submission = NonNullable<Schemas['KycFormsSubmission']>;
+            export type SubmissionStatus = Submission['status'];
+            export type FieldValue = Schemas['KycFormsFieldValue'];
+            export type AnswerValue = Schemas['KycFormsAnswerValue'];
+            export type FileValue = Schemas['KycFormsFileValue'];
+            export type ListItemValue = Schemas['KycFormsListItemValue'];
+            export type ErrorDetails = Schemas['KycFormsErrorDetails'];
+            export namespace Entities {
+                namespace Create {
+                    type Request = EntitiesRoot['post']['requestBody']['content']['application/json'];
+                    type Response = EntitiesRoot['post']['responses'][201]['content']['application/json'];
+                }
+                namespace List {
+                    type Response = EntitiesRoot['get']['responses'][200]['content']['application/json'];
+                }
+                namespace Get {
+                    type Request = EntityRoot['get']['parameters']['path'];
+                    type Response = EntityRoot['get']['responses'][200]['content']['application/json'];
+                }
+                namespace Overview {
+                    type Request = OverviewRoot['get']['parameters']['path'] & NonNullable<OverviewRoot['get']['parameters']['query']>;
+                    type Response = OverviewRoot['get']['responses'][200]['content']['application/json'];
+                }
+                namespace Targets {
+                    type Request = EntityTargetsRoot['get']['parameters']['path'] & NonNullable<EntityTargetsRoot['get']['parameters']['query']>;
+                    type Response = EntityTargetsRoot['get']['responses'][200]['content']['application/json'];
+                }
+            }
+            export namespace Targets {
+                namespace List {
+                    type Request = TypeTargetsRoot['get']['parameters']['query'];
+                    type Response = TypeTargetsRoot['get']['responses'][200]['content']['application/json'];
+                }
+            }
+            export namespace Forms {
+                type Target = NonNullable<FormsRoot['get']['parameters']['query']>;
+                namespace Get {
+                    type Request = FormsRoot['get']['parameters']['path'] & Target;
+                    type Response = FormsRoot['get']['responses'][200]['content']['application/json'];
+                }
+                namespace SaveDraft {
+                    type Request = DraftRoot['put']['parameters']['path'] & NonNullable<DraftRoot['put']['parameters']['query']> & DraftRoot['put']['requestBody']['content']['application/json'];
+                    type Response = DraftRoot['put']['responses'][200]['content']['application/json'];
+                }
+                namespace Upload {
+                    type Body = UploadsRoot['post']['requestBody']['content']['multipart/form-data'];
+                    export type Request = UploadsRoot['post']['parameters']['path'] & NonNullable<UploadsRoot['post']['parameters']['query']> & Omit<Body, 'file'> & {
+                        file: File | Blob;
+                    } & UploadOptions;
+                    export type Response = UploadsRoot['post']['responses'][201]['content']['application/json'];
+                    export {};
+                }
+                namespace RemoveUpload {
+                    type Request = UploadRoot['delete']['parameters']['path'] & NonNullable<UploadRoot['delete']['parameters']['query']>;
+                    type Response = UploadRoot['delete']['responses'][200]['content']['application/json'];
+                }
+                namespace Submit {
+                    type Request = SubmitRoot['post']['parameters']['path'] & NonNullable<SubmitRoot['post']['parameters']['query']> & SubmitRoot['post']['requestBody']['content']['application/json'];
+                    type Response = SubmitRoot['post']['responses'][200]['content']['application/json'];
+                }
+            }
+            export namespace Verification {
+                namespace Session {
+                    type Request = SessionRoot['post']['parameters']['path'];
+                    type Response = SessionRoot['post']['responses'][200]['content']['application/json'];
+                }
+                namespace Owners {
+                    namespace Link {
+                        type Request = OwnerLinkRoot['post']['parameters']['path'];
+                        type Response = OwnerLinkRoot['post']['responses'][200]['content']['application/json'];
+                    }
+                    namespace Session {
+                        type Request = OwnerSessionRoot['post']['parameters']['path'];
+                        type Response = OwnerSessionRoot['post']['responses'][200]['content']['application/json'];
+                    }
+                    namespace Document {
+                        type Body = OwnerDocumentRoot['post']['requestBody']['content']['multipart/form-data'];
+                        export type Side = Body['side'];
+                        export type Type = NonNullable<Body['type']>;
+                        export type Request = OwnerDocumentRoot['post']['parameters']['path'] & Omit<Body, 'file'> & {
+                            file: File | Blob;
+                        } & UploadOptions;
+                        export type Response = OwnerDocumentRoot['post']['responses'][201]['content']['application/json'];
+                        export {};
+                    }
+                    namespace Invite {
+                        type Request = OwnersInviteRoot['post']['parameters']['path'];
+                        type Response = OwnersInviteRoot['post']['responses'][200]['content']['application/json'];
+                    }
+                }
+            }
+            export {};
+        }
         namespace Reference {
             namespace ExchangeRates {
                 type ExchangeRatesRoot = pathsV1Frontend['/frontend/reference/exchange_rates'];

package/dist/constants.d.ts

@@ -333,7 +333,9 @@ export declare enum KYCStatuses {
     REJECT = "REJECT",
     UNVERIFIED = "UNVERIFIED",
     WAITING_ON_UBOS = "WAITING_ON_UBOS",
-    WAITING_ON_REVIEW = "WAITING_ON_REVIEW"
+    WAITING_ON_REVIEW = "WAITING_ON_REVIEW",
+    EXPIRED = "EXPIRED",
+    OFFBOARDED = "OFFBOARDED"
 }
 export declare const KYCStatusCheck: IsEnumEqualToUnion<KYCStatuses, API.KYC.KYCStatus>;
 export type KYCStatusMismatch = EnumUnionMismatch<KYCStatuses, API.KYC.KYCStatus>;

package/dist/constants.js

@@ -349,6 +349,8 @@ export var KYCStatuses;
     KYCStatuses["UNVERIFIED"] = "UNVERIFIED";
     KYCStatuses["WAITING_ON_UBOS"] = "WAITING_ON_UBOS";
     KYCStatuses["WAITING_ON_REVIEW"] = "WAITING_ON_REVIEW";
+    KYCStatuses["EXPIRED"] = "EXPIRED";
+    KYCStatuses["OFFBOARDED"] = "OFFBOARDED";
 })(KYCStatuses || (KYCStatuses = {}));
 export const KYCStatusCheck = true;
 // Steps of the per-user verification ladder passed to `user.verification.init`.

package/package.json

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