squarefi-bff-api-module 1.17.23 → 1.17.24

package/CHANGELOG.md

@@ -5,6 +5,30 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.17.26] - 2025-05-14
+
+### Added
+
+- Added Persona inquiries initialization for advanced KYC workflows
+
+## [1.17.25] - 2025-05-14
+
+### Added
+
+- Added Rails and Forms namespaces with new types and methods for KYC integration
+  - Enhanced support for onboarding and compliance flows
+
+## [1.17.24] - 2025-05-14
+
+### Added
+
+- Persona inquiries initialization for advanced KYC workflows
+- Rails and Forms namespaces with new types and methods for KYC integration (onboarding/compliance flows)
+
+### Changed
+
+- Removed ExtendedSubAccount type definitions to streamline API types (simplified and unified sub-account type management)
+
 ## [1.17.23] - 2025-05-12
 
 ### Changed

package/README.md

@@ -86,6 +86,7 @@ Access different API functionalities through the client:
   - Card status management
 - `squarefi_bff_api_client.kyc` - Know Your Customer procedures
   - Sumsub integration
+  - Persona inquiries initialization
 - `squarefi_bff_api_client.list` - System data operations
   - Currencies list (`/system/currencies`)
   - Chains list (`/system/chains`)
@@ -94,6 +95,10 @@ Access different API functionalities through the client:
   - Create orders by type
   - Calculate exchange rates
   - Support for INTERNAL_TRANSFER order type
+- `squarefi_bff_api_client.rails` - KYC onboarding rails
+  - Manage onboarding rails and flows
+- `squarefi_bff_api_client.forms` - KYC forms
+  - Manage and submit KYC forms
 - `squarefi_bff_api_client.tenants` - Tenant management operations
   - Tenant configuration
 - `squarefi_bff_api_client.user` - User profile operations
@@ -125,6 +130,8 @@ Access different API functionalities through the client:
 - 📦 Comprehensive constants and types
 - 🛡️ Secure request handling
 - 🔑 Multi-tenant support
+- 🧩 Persona KYC integration
+- 📝 Rails and Forms modules for flexible onboarding/compliance
 
 ## 🛠️ Development
 

package/dist/api/kyc.d.ts

@@ -3,4 +3,13 @@ export declare const kyc: {
     sumsub: {
         generate_token: (data: API.KYC.Sumsub.GenerateToken.Request) => Promise<API.KYC.Sumsub.GenerateToken.Response>;
     };
+    rails: {
+        info: {
+            getAll: ({ wallet_id }: API.KYC.Rails.RailInfo.List.Request) => Promise<API.KYC.Rails.RailInfo.List.Response>;
+            getSingle: ({ wallet_id, rail_id }: API.KYC.Rails.RailInfo.SingleRail.Request) => Promise<API.KYC.Rails.RailInfo.RailInfo>;
+        };
+        submit: {
+            single: ({ wallet_id, rail_id }: API.KYC.Rails.Submit.Single.Request) => Promise<API.KYC.Rails.RailInfo.RailInfo>;
+        };
+    };
 };

package/dist/api/kyc.js

@@ -6,4 +6,13 @@ exports.kyc = {
     sumsub: {
         generate_token: (data) => apiClientFactory_1.apiClientV1.postRequest('/kyc/sumsub/generate_token', { data }),
     },
+    rails: {
+        info: {
+            getAll: ({ wallet_id }) => apiClientFactory_1.apiClientV2.getRequest(`/kyc/${wallet_id}/rails`),
+            getSingle: ({ wallet_id, rail_id }) => apiClientFactory_1.apiClientV2.getRequest(`/kyc/${wallet_id}/rails/${rail_id}`),
+        },
+        submit: {
+            single: ({ wallet_id, rail_id }) => apiClientFactory_1.apiClientV2.postRequest(`/kyc/${wallet_id}/rails/${rail_id}`),
+        },
+    },
 };

package/dist/api/persona.d.ts

@@ -0,0 +1,6 @@
+import { API } from './types';
+export declare const persona: {
+    inquiries: {
+        init: ({ wallet_id, type }: API.Persona.Inquiries.Init.Request) => Promise<API.Persona.Inquiries.Init.Response>;
+    };
+};

package/dist/api/persona.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.persona = void 0;
+const apiClientFactory_1 = require("../utils/apiClientFactory");
+exports.persona = {
+    inquiries: {
+        init: ({ wallet_id, type }) => apiClientFactory_1.apiClientV2.getRequest(`/persona/inquiries/${wallet_id}/${type}`),
+    },
+};

package/dist/api/types.d.ts

@@ -844,6 +844,93 @@ export declare namespace API {
                 }
             }
         }
+        namespace Forms {
+            namespace FormField {
+                type FormFieldType = 'text' | 'email' | 'password' | 'radio' | 'select' | 'checkbox' | 'textarea' | 'number' | 'date' | 'switch' | 'file';
+                interface FormFieldValidation {
+                    pattern?: string;
+                    min?: number;
+                    max?: number;
+                    min_length?: number;
+                    max_length?: number;
+                    message?: string;
+                }
+                interface FormFieldOption {
+                    label: string;
+                    value: string;
+                }
+                interface FormField {
+                    name: string;
+                    type: FormFieldType;
+                    label: string;
+                    placeholder?: string;
+                    required?: boolean;
+                    order?: number;
+                    options?: FormFieldOption[];
+                    rows?: number;
+                    value?: string;
+                    accept?: string;
+                    validation?: FormFieldValidation;
+                }
+            }
+            namespace FormGroup {
+                type FormGroupFieldType = 'group' | 'field';
+                interface FormGroupFieldGroup {
+                    type: 'group';
+                    fields: API.KYC.Forms.FormGroup.FormGroup[];
+                }
+                interface FormGroupFieldField {
+                    type: 'field';
+                    field: API.KYC.Forms.FormField.FormField;
+                }
+                interface FormGroup {
+                    name?: string;
+                    isArray?: boolean;
+                    label: string;
+                    fields: Array<FormGroupFieldGroup | FormGroupFieldField>;
+                }
+            }
+        }
+        namespace Rails {
+            type RailStatus = 'APPROVED' | 'DECLINED' | 'PENDING' | 'HOLD' | 'DOUBLE' | 'SOFT_REJECT' | 'REJECT' | 'UNVERIFIED';
+            interface WalletRail {
+                id: string;
+                status: API.KYC.Rails.RailStatus;
+            }
+            namespace RailInfo {
+                interface RailInfo {
+                    id: string;
+                    code: string;
+                    name: string;
+                    wallet_rail: WalletRail;
+                }
+                namespace SingleRail {
+                    interface Request {
+                        wallet_id: string;
+                        rail_id: string;
+                    }
+                    type Response = RailInfo;
+                }
+                namespace List {
+                    interface Request {
+                        wallet_id: string;
+                    }
+                    type Response = {
+                        total: number;
+                        data: RailInfo[];
+                    };
+                }
+            }
+            namespace Submit {
+                namespace Single {
+                    interface Request {
+                        wallet_id: string;
+                        rail_id: string;
+                    }
+                    type Response = API.KYC.Rails.RailInfo.RailInfo;
+                }
+            }
+        }
     }
     namespace Location {
         namespace Countries {
@@ -1285,6 +1372,77 @@ export declare namespace API {
             }
         }
     }
+    namespace Persona {
+        namespace Inquiries {
+            type InquiryType = 'individual' | 'business';
+            namespace Init {
+                interface Request {
+                    wallet_id: string;
+                    type: InquiryType;
+                }
+                type Response = {
+                    referenceId: string;
+                    templateId: string;
+                };
+            }
+        }
+    }
+    namespace VirtualAccount {
+        namespace Programs {
+            interface OrderType {
+                id: string;
+                description: string | null;
+            }
+            interface OrderTypeListItem {
+                order_type: OrderType;
+                order_type_id: string;
+            }
+            interface CurrencyItem {
+                icon: string | null;
+                name: string;
+                type: string;
+                uuid: string;
+                symbol: string;
+            }
+            interface IntegrationVendor {
+                id: string;
+                code: string;
+                name: string;
+            }
+            interface Program {
+                id: string;
+                name: string;
+                vendor_id: string | null;
+                tenant_id: string;
+                status: string;
+                account_currency_id: string;
+                description: string;
+                icon: string | null;
+                code: string;
+                kyc_rails_id: string;
+                consent_text: string | null;
+                integration_vendors_id: string;
+                is_hidden: boolean;
+                destination_currency_id: string;
+                integration_vendor: API.VirtualAccount.Programs.IntegrationVendor;
+                account_currency_details: API.VirtualAccount.Programs.CurrencyItem;
+                destination_currency_details: API.VirtualAccount.Programs.CurrencyItem;
+                virtual_accounts_programs_order_types: API.VirtualAccount.Programs.OrderTypeListItem[];
+            }
+            namespace List {
+                interface Request {
+                    offset?: number;
+                    limit?: number;
+                    pagination?: boolean;
+                }
+                interface Response {
+                    data: Program[];
+                    count: number;
+                    has_more: boolean;
+                }
+            }
+        }
+    }
     namespace User {
         interface User {
             id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarefi-bff-api-module",
-  "version": "1.17.23",
+  "version": "1.17.24",
   "description": "Squarefi BFF API client module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/api/kyc.ts

@@ -1,10 +1,22 @@
 import { API } from './types';
 
-import { apiClientV1 } from '../utils/apiClientFactory';
+import { apiClientV1, apiClientV2 } from '../utils/apiClientFactory';
 
 export const kyc = {
   sumsub: {
     generate_token: (data: API.KYC.Sumsub.GenerateToken.Request) =>
       apiClientV1.postRequest<API.KYC.Sumsub.GenerateToken.Response>('/kyc/sumsub/generate_token', { data }),
   },
+  rails: {
+    info: {
+      getAll: ({ wallet_id }: API.KYC.Rails.RailInfo.List.Request) =>
+        apiClientV2.getRequest<API.KYC.Rails.RailInfo.List.Response>(`/kyc/${wallet_id}/rails`),
+      getSingle: ({ wallet_id, rail_id }: API.KYC.Rails.RailInfo.SingleRail.Request) =>
+        apiClientV2.getRequest<API.KYC.Rails.RailInfo.SingleRail.Response>(`/kyc/${wallet_id}/rails/${rail_id}`),
+    },
+    submit: {
+      single: ({ wallet_id, rail_id }: API.KYC.Rails.Submit.Single.Request) =>
+        apiClientV2.postRequest<API.KYC.Rails.Submit.Single.Response>(`/kyc/${wallet_id}/rails/${rail_id}`),
+    },
+  },
 };

package/src/api/persona.ts

@@ -0,0 +1,9 @@
+import { apiClientV2 } from '../utils/apiClientFactory';
+import { API } from './types';
+
+export const persona = {
+  inquiries: {
+    init: ({ wallet_id, type }: API.Persona.Inquiries.Init.Request) =>
+      apiClientV2.getRequest<API.Persona.Inquiries.Init.Response>(`/persona/inquiries/${wallet_id}/${type}`),
+  },
+};

package/src/api/types.ts

@@ -1001,6 +1001,121 @@ export namespace API {
         }
       }
     }
+    export namespace Forms {
+      export namespace FormField {
+        export type FormFieldType =
+          | 'text'
+          | 'email'
+          | 'password'
+          | 'radio'
+          | 'select'
+          | 'checkbox'
+          | 'textarea'
+          | 'number'
+          | 'date'
+          | 'switch'
+          | 'file';
+
+        export interface FormFieldValidation {
+          pattern?: string;
+          min?: number;
+          max?: number;
+          min_length?: number;
+          max_length?: number;
+          message?: string;
+        }
+
+        export interface FormFieldOption {
+          label: string;
+          value: string;
+        }
+        export interface FormField {
+          name: string;
+          type: FormFieldType;
+          label: string;
+          placeholder?: string;
+          required?: boolean;
+          order?: number;
+          options?: FormFieldOption[];
+          rows?: number;
+          value?: string;
+          accept?: string;
+          validation?: FormFieldValidation;
+        }
+      }
+
+      export namespace FormGroup {
+        export type FormGroupFieldType = 'group' | 'field';
+        export interface FormGroupFieldGroup {
+          type: 'group';
+          fields: API.KYC.Forms.FormGroup.FormGroup[];
+        }
+        export interface FormGroupFieldField {
+          type: 'field';
+          field: API.KYC.Forms.FormField.FormField;
+        }
+        export interface FormGroup {
+          name?: string;
+          isArray?: boolean;
+          label: string;
+          fields: Array<FormGroupFieldGroup | FormGroupFieldField>;
+        }
+      }
+    }
+
+    export namespace Rails {
+      export type RailStatus =
+        | 'APPROVED'
+        | 'DECLINED'
+        | 'PENDING'
+        | 'HOLD'
+        | 'DOUBLE'
+        | 'SOFT_REJECT'
+        | 'REJECT'
+        | 'UNVERIFIED';
+
+      export interface WalletRail {
+        id: string;
+        status: API.KYC.Rails.RailStatus;
+      }
+
+      export namespace RailInfo {
+        export interface RailInfo {
+          id: string;
+          code: string;
+          name: string;
+          wallet_rail: WalletRail;
+        }
+
+        export namespace SingleRail {
+          export interface Request {
+            wallet_id: string;
+            rail_id: string;
+          }
+          export type Response = RailInfo;
+        }
+
+        export namespace List {
+          export interface Request {
+            wallet_id: string;
+          }
+          export type Response = {
+            total: number;
+            data: RailInfo[];
+          };
+        }
+      }
+
+      export namespace Submit {
+        export namespace Single {
+          export interface Request {
+            wallet_id: string;
+            rail_id: string;
+          }
+          export type Response = API.KYC.Rails.RailInfo.RailInfo;
+        }
+      }
+    }
   }
 
   export namespace Location {
@@ -1556,6 +1671,83 @@ export namespace API {
     // }
   }
 
+  export namespace Persona {
+    export namespace Inquiries {
+      export type InquiryType = 'individual' | 'business';
+      export namespace Init {
+        export interface Request {
+          wallet_id: string;
+          type: InquiryType;
+        }
+        export type Response = {
+          referenceId: string;
+          templateId: string;
+        };
+      }
+    }
+  }
+
+  export namespace VirtualAccount {
+    export namespace Programs {
+      export interface OrderType {
+        id: string;
+        description: string | null;
+      }
+      export interface OrderTypeListItem {
+        order_type: OrderType;
+        order_type_id: string;
+      }
+
+      export interface CurrencyItem {
+        icon: string | null;
+        name: string;
+        type: string;
+        uuid: string;
+        symbol: string;
+      }
+
+      export interface IntegrationVendor {
+        id: string;
+        code: string;
+        name: string;
+      }
+
+      export interface Program {
+        id: string;
+        name: string;
+        vendor_id: string | null;
+        tenant_id: string;
+        status: string;
+        account_currency_id: string;
+        description: string;
+        icon: string | null;
+        code: string;
+        kyc_rails_id: string;
+        consent_text: string | null;
+        integration_vendors_id: string;
+        is_hidden: boolean;
+        destination_currency_id: string;
+        integration_vendor: API.VirtualAccount.Programs.IntegrationVendor;
+        account_currency_details: API.VirtualAccount.Programs.CurrencyItem;
+        destination_currency_details: API.VirtualAccount.Programs.CurrencyItem;
+        virtual_accounts_programs_order_types: API.VirtualAccount.Programs.OrderTypeListItem[];
+      }
+
+      export namespace List {
+        export interface Request {
+          offset?: number;
+          limit?: number;
+          pagination?: boolean;
+        }
+        export interface Response {
+          data: Program[];
+          count: number;
+          has_more: boolean;
+        }
+      }
+    }
+  }
+
   export namespace User {
     export interface User {
       id: string;