squarefi-bff-api-module 1.36.88 → 1.36.90

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

@@ -1586,8 +1586,37 @@ export interface components {
             state_province_region?: string | null;
             id?: string;
         };
+        KycDocumentDto: {
+            /** Format: uuid */
+            readonly id?: string;
+            /** Format: uuid */
+            readonly kyc_entity_id?: string;
+            /**
+             * Format: uuid
+             * @description Beneficial owner the document belongs to; null for the entity itself.
+             */
+            readonly ubo_id?: Record<string, never> | null;
+            /**
+             * @description Document type.
+             * @example formation_doc
+             * @enum {string}
+             */
+            type: "supplementary" | "gov_id_front" | "gov_id_back" | "gov_id_hand_hold" | "selfie" | "proof_of_address" | "auth_letter" | "formation_doc" | "proof_of_ownership" | "certificate_of_registration_doc" | "business_registration_doc" | "share_structure" | "constitution_or_annual_report" | "articles_of_association" | "ubo_declaration" | "partnership_mins_of_meeting" | "partnership_deed" | "certificate_of_incumbency" | "regulatory_license" | "state_registry_doc" | "good_standing_cert" | "business_proof_of_address" | "invoices" | "contracts" | "financial_statements" | "source_of_funds" | "business_bank_statement" | "source_of_wealth_ubo" | "customer_supplier_agreements";
+            /** Format: uri */
+            link: string;
+            /** @example bff */
+            readonly source?: string;
+            /**
+             * Format: uuid
+             * @description Shared by the files filed together (one submission); the newest batch of a type is its current set.
+             */
+            readonly batch_id?: string;
+            /** @description Order of the file within its batch, from 0. */
+            readonly position?: number;
+            /** Format: date-time */
+            readonly created_at?: string;
+        };
         KycBeneficialOwnerDto: {
-            auth_letter_url: string | null;
             business_title: string | null;
             country_of_birth: string | null;
             date_of_birth: string | null;
@@ -1598,10 +1627,8 @@ export interface components {
             last_name_local: string | null;
             middle_name: string | null;
             middle_name_local: string | null;
-            gov_id_back_url: string | null;
             gov_id_country: string | null;
             gov_id_expiration_date: string | null;
-            gov_id_front_url: string | null;
             gov_id_issuance_authority: string | null;
             gov_id_issuance_date: string | null;
             gov_id_number: string | null;
@@ -1614,15 +1641,12 @@ export interface components {
             phone: string | null;
             /** @enum {string|null} */
             proof_of_address_type: "UTILITY_BILL" | "BANK_STATEMENT" | "RENTAL_AGREEMENT" | "TAX_DOCUMENT" | null;
-            proof_of_address_url: string | null;
             relationship_established_at: string | null;
             /** @enum {string|null} */
             role?: "OWNER_OR_OPERATOR" | "PARTNER" | "UBO" | "DIRECTOR_CONTROL_PERSON_OR_LEGAL_REP" | "AGENT_OR_AUTHORISED_PERSON" | null;
             share_proportion: string | null;
             supplementary_info: string | null;
-            supplementary_url: string | null;
             tax_identification_number: string | null;
-            selfie_url?: string | null;
             /**
              * @default individual
              * @enum {string|null}
@@ -1635,6 +1659,8 @@ export interface components {
             corporate_country: string | null;
             id?: string;
             address?: components["schemas"]["KycAddressDto"] | null;
+            /** @description KYC documents of this beneficial owner. Request: documents to file for the owner (type + link). */
+            documents?: components["schemas"]["KycDocumentDto"][];
         };
         KycEntityDto: {
             id: string;
@@ -1647,22 +1673,17 @@ export interface components {
             id_type?: "PASSPORT" | "ID_CARD" | "DRIVERS" | "NIN" | null;
             additional_id_number?: string | null;
             additional_id_type?: string | null;
-            articles_of_association_url?: string | null;
             business_description?: string | null;
             business_industry?: string[] | null;
             business_industry_other?: string | null;
             business_name?: string | null;
             business_name_local?: string | null;
-            business_registration_doc_url?: string | null;
             /** @enum {string|null} */
             business_type?: "cooperative" | "s_corporation" | "b_corporation" | "c_corporation" | "close_corporation" | "nonprofit_corporation" | "general_partnership" | "limited_partnership" | "limited_liability_company" | "other" | "sole_proprietorship" | "trust" | null;
             certificate_number?: string | null;
-            certificate_of_incumbency_url?: string | null;
             /** @enum {string|null} */
             certificate_of_registration_doc_type?: "ACRA" | "GST" | "MSME" | "CERTIFICATE_OF_REGISTRATION" | null;
-            certificate_of_registration_doc_url?: string | null;
             compliance_screening_explanation?: string | null;
-            constitution_or_annual_report_url?: string | null;
             country_of_birth?: string | null;
             /** @default false */
             dao_status: boolean | null;
@@ -1673,12 +1694,8 @@ export interface components {
             first_name?: string | null;
             first_name_local?: string | null;
             formation_date?: string | null;
-            formation_doc_url?: string | null;
-            gov_id_back_url?: string | null;
             gov_id_country?: string | null;
             gov_id_expiration_date?: string | null;
-            gov_id_front_url?: string | null;
-            gov_id_hand_hold_url?: string | null;
             gov_id_issuance_authority?: string | null;
             gov_id_issuance_date?: string | null;
             gov_id_number?: string | null;
@@ -1691,23 +1708,17 @@ export interface components {
             middle_name?: string | null;
             middle_name_local?: string | null;
             nationality?: string | null;
-            partnership_deed_url?: string | null;
-            partnership_mins_of_meeting_url?: string | null;
             phone?: string | null;
             product_service_category?: string | null;
             /** @enum {string|null} */
             proof_of_address_type?: "UTILITY_BILL" | "BANK_STATEMENT" | "RENTAL_AGREEMENT" | "TAX_DOCUMENT" | null;
-            proof_of_address_url?: string | null;
-            proof_of_ownership_url?: string | null;
             /** @enum {string|null} */
             purpose?: "charitable_donations" | "ecommerce_retail_payments" | "investment_purposes" | "other" | "payments_to_friends_or_family_abroad" | "payroll" | "personal_or_living_expenses" | "protect_wealth" | "purchase_goods_and_services" | "receive_payments_for_goods_and_services" | "tax_optimization" | "third_party_money_transmission" | "treasury_management" | "operating_a_company" | "receive_payment_for_freelancing" | "receive_salary" | null;
             purpose_other?: string | null;
             registration_number?: string | null;
-            share_structure_url?: string | null;
             /** @enum {string|null} */
             source_of_funds?: "employment" | "savings" | "winnings" | "marital" | "real_estate" | "trust" | "investment" | "other" | "sales_of_goods_and_services" | "owners_capital" | "business_loans" | "private_capital" | "grant" | null;
             supplementary_info?: string | null;
-            supplementary_url?: string | null;
             tax_identification_number?: string | null;
             /** @enum {string|null} */
             tax_identification_number_type?: "EIN" | "SSN" | "VAT" | "TIN" | "UTR" | null;
@@ -1716,10 +1727,7 @@ export interface components {
             trade_type?: "00" | "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31" | "32" | "33" | "34" | "35" | "36" | "37" | "38" | "39" | "40" | "41" | null;
             /** @default false */
             transmits_customer_funds: boolean | null;
-            ubo_declaration_url?: string | null;
             website?: string | null;
-            selfie_url?: string | null;
-            regulatory_license_url?: string | null;
             annual_salary?: string | null;
             expected_monthly_volume?: string | null;
             monthly_crypto_deposits?: string | null;
@@ -1770,31 +1778,25 @@ export interface components {
             regulatory_authority_name?: string | null;
             regulatory_authority_country?: string | null;
             regulatory_license_number?: string | null;
-            regulatory_license_urls?: string[] | null;
-            state_registry_doc_url?: string | null;
-            good_standing_cert_url?: string | null;
-            business_proof_of_address_url?: string | null;
             /** @enum {string|null} */
             business_proof_of_address_type?: "UTILITY_BILL" | "BANK_STATEMENT" | "RENTAL_AGREEMENT" | "TAX_DOCUMENT" | null;
-            invoices_url?: string[] | null;
             invoices_absence_reason?: string | null;
-            contracts_url?: string[] | null;
             contracts_absence_reason?: string | null;
-            financial_statements_url?: string | null;
-            source_of_funds_url?: string | null;
-            business_bank_statement_url?: string[] | null;
             professional_description?: string | null;
             source_of_accumulated?: string | null;
             send_and_receive?: string | null;
             employment_status_other?: string | null;
             source_of_wealth_ubo?: string | null;
-            source_of_wealth_ubo_url?: string | null;
+            customer_acquisition_and_location?: string | null;
+            funds_senders_and_recipients?: string | null;
             purposes?: string[] | null;
             payment_flows?: string[] | null;
             source_of_funds_list?: string[] | null;
             address?: components["schemas"]["KycAddressDto"] | null;
             physical_address?: components["schemas"]["KycAddressDto"] | null;
             beneficial_owners?: components["schemas"]["KycBeneficialOwnerDto"][] | null;
+            /** @description KYC documents. Response: every document of the entity and of its beneficial owners (ubo_id set). Request: documents to file for the entity (type + link). */
+            documents?: components["schemas"]["KycDocumentDto"][];
         };
         WalletKycRailExtraActionDto: {
             /** @enum {string} */

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

@@ -109,6 +109,8 @@ export declare namespace API {
             /** Hex colour for every text on the card face (balance, nickname, PAN). */
             text_color?: string;
         }
+        /** A mobile wallet a card can be added to; follows the frontend program schema. */
+        type DigitalWallet = componentsV1Frontend['schemas']['IssuingProgram']['digital_wallets'][number];
         namespace Config {
             type IssuingProgramOrderType = {
                 id: string;
@@ -124,7 +126,17 @@ export declare namespace API {
                 name: string;
                 max_cards: number;
                 realtime_auth: boolean;
+                /** At least one mobile wallet is supported; which ones: `digital_wallets`. */
                 tokenizable: boolean;
+                /**
+                 * Mobile wallets cards of this program can be added to; empty = none. A
+                 * program can support Google Pay without Apple Pay.
+                 *
+                 * Optional on the type because a backend older than the
+                 * `issuing_programs.digital_wallets` migration omits it: read it with a
+                 * fallback to `tokenizable` (true = both wallets).
+                 */
+                digital_wallets?: API.Cards.DigitalWallet[];
                 kyc_rails_id: string;
                 integration_vendor_id: string;
                 vendor_id: string;
@@ -230,7 +242,20 @@ export declare namespace API {
             name_on_card: string | null;
             type: CardType | string;
             form_factor: CardFormFactor | string;
+            /** Set when the card was issued; never rewritten from the program. */
             tokenizable: boolean;
+            /**
+             * Mobile wallets this card can be added to: its program's wallets, or none
+             * when `tokenizable` is false; a card with no program and `tokenizable`
+             * true lists both.
+             *
+             * Absent when the card's program could not be read (unknown, not "both")
+             * and on a backend older than the field. Without it, read it the way the
+             * backend does: none when `tokenizable` is false, otherwise the program's
+             * `digital_wallets` when the program is at hand (an empty list means
+             * none), both only when there is no program to ask.
+             */
+            digital_wallets?: API.Cards.DigitalWallet[];
             /**
              * This card's artwork, copied from its issuing program. Served WITH the
              * card on purpose: joining against the program catalogue client-side
@@ -252,6 +277,8 @@ export declare namespace API {
             wallet_id: string;
             type: string;
             tokenizable: boolean;
+            /** This card's mobile wallets; see `IssuingCardListItem.digital_wallets`. */
+            digital_wallets?: API.Cards.DigitalWallet[];
             issuing_programs: API.Cards.Config.Program;
             limits?: API.Cards.Limits.Limits;
             /** This card's artwork; see `IssuingCardListItem.card_design`. */
@@ -2754,28 +2781,20 @@ export declare namespace API {
             }
             namespace List {
                 namespace ByWallet {
-                    interface Request {
-                        wallet_uuid: string;
-                        offset?: number;
-                        limit?: number;
-                        sort_by?: string;
-                        sort_order?: 'asc' | 'desc';
+                    type ByWalletRoot = pathsV1Frontend['/frontend/orders/wallet/{wallet_uuid}'];
+                    export type Request = ByWalletRoot['get']['parameters']['path'] & Omit<NonNullable<ByWalletRoot['get']['parameters']['query']>, 'filters'> & {
                         filters?: API.Orders.V2.List.ByWallet.OrderListFilter[];
-                        date_from?: string;
-                        date_to?: string;
-                        show_low_balance?: 'true' | 'false';
-                    }
-                    type Response = pathsV1Frontend['/frontend/orders/wallet/{wallet_uuid}']['get']['responses'][200]['content']['application/json'];
+                    };
+                    export type Response = ByWalletRoot['get']['responses'][200]['content']['application/json'];
+                    export {};
                 }
                 namespace Csv {
-                    interface Request {
-                        wallet_uuid: string;
+                    type CsvRoot = pathsV1Frontend['/frontend/orders/wallet/{wallet_uuid}/csv'];
+                    export type Request = CsvRoot['get']['parameters']['path'] & Omit<NonNullable<CsvRoot['get']['parameters']['query']>, 'filters'> & {
                         filters?: API.Orders.V2.List.ByWallet.OrderListFilter[];
-                        date_from?: string;
-                        date_to?: string;
-                        show_low_balance?: 'true' | 'false';
-                    }
-                    type Response = string;
+                    };
+                    export type Response = string;
+                    export {};
                 }
             }
             namespace ScheduledFunding {

package/package.json

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