squarefi-bff-api-module 1.36.41 → 1.36.43

package/dist/api/frontend.d.ts

@@ -33,5 +33,11 @@ export declare const frontend: {
             deposit: ({ sub_account_id, ...data }: API.Frontend.Issuing.SubAccounts.Deposit.Request) => Promise<API.Frontend.Issuing.SubAccounts.Deposit.Response>;
             withdraw: ({ sub_account_id, ...data }: API.Frontend.Issuing.SubAccounts.Withdraw.Request) => Promise<API.Frontend.Issuing.SubAccounts.Withdraw.Response>;
         };
+        config: {
+            programs: {
+                getAll: (params?: API.Frontend.Issuing.Config.Programs.List.Request) => Promise<API.Frontend.Issuing.Config.Programs.List.Response>;
+                getById: ({ id, ...params }: API.Frontend.Issuing.Config.Programs.Get.Request) => Promise<API.Frontend.Issuing.Config.Programs.Get.Response>;
+            };
+        };
     };
 };

package/dist/api/frontend.js

@@ -85,5 +85,15 @@ export const frontend = {
             // taken from the sub-account, so only the amount is needed.
             withdraw: ({ sub_account_id, ...data }) => apiClientV1Frontend.postRequest(`/frontend/issuing/sub-accounts/${sub_account_id}/withdraw`, { data }),
         },
+        // Program catalogue. Unlike the legacy `issuing.config.programs` (GET
+        // /issuing/config/programs), the frontend route carries each program's
+        // `cardholder_requirements` (the per-program cardholder KYC bar) and keeps
+        // `kyc_rails_id` so the wallet can hide programs on a closed/rejected rail.
+        config: {
+            programs: {
+                getAll: (params = {}) => apiClientV1Frontend.getRequest('/frontend/issuing/config/programs', { params }),
+                getById: ({ id, ...params }) => apiClientV1Frontend.getRequest(`/frontend/issuing/config/programs/${id}`, { params }),
+            },
+        },
     },
 };

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

@@ -4524,6 +4524,10 @@ export interface paths {
          *     - `PENDING` — a verification review is in flight; wait.
          *     - `NEEDS_VERIFICATION` — no approved verification or no KYC applicant; the member has
          *       to (re)run identity verification.
+         *     - `NEEDS_VERIFICATION_UPGRADE` — the member IS verified, but not to the level this program
+         *       demands (a required document — usually the selfie — was never captured). Read
+         *       `required_level` to name the bar ("requires FULL verification"). Same remediation as
+         *       `NEEDS_VERIFICATION`, run to add the missing step.
          *     - `REJECTED` — a verification came back with a FINAL rejection; re-running it from the
          *       app is not possible (support resets it), so never render a "verify now" action.
          *     - `NOT_MEMBER` — the uuid is not an active member of this wallet.
@@ -4576,7 +4580,7 @@ export interface paths {
                                 /** Format: uuid */
                                 user_data_id: string;
                                 /** @enum {string} */
-                                verdict: "READY" | "DRAFT" | "CAN_CREATE" | "PENDING" | "NEEDS_VERIFICATION" | "REJECTED" | "NOT_MEMBER";
+                                verdict: "READY" | "DRAFT" | "CAN_CREATE" | "PENDING" | "NEEDS_VERIFICATION" | "NEEDS_VERIFICATION_UPGRADE" | "REJECTED" | "NOT_MEMBER";
                                 /**
                                  * Format: uuid
                                  * @description The linked cardholder for READY/DRAFT verdicts
@@ -4584,6 +4588,14 @@ export interface paths {
                                 cardholder_id: string | null;
                                 /** @description Fields to collect by hand (submit `missing` vocabulary) */
                                 will_require: string[];
+                                /**
+                                 * @description The KYC level this program demands. Lets the client name the bar in
+                                 *     the copy (e.g. "requires FULL verification" on a NEEDS_VERIFICATION
+                                 *     row). Null when the program bar could not be read.
+                                 *
+                                 * @enum {string|null}
+                                 */
+                                required_level?: "minimal" | "basic" | "full" | null;
                             }[];
                         };
                     };

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

@@ -850,6 +850,13 @@ export declare namespace API {
                      | 'PENDING'
                     /** No approved verification or no KYC applicant — the member must verify. */
                      | 'NEEDS_VERIFICATION'
+                    /**
+                     * The member IS verified, but not to the level THIS program demands (a
+                     * required document — usually the selfie — was never captured). Same
+                     * remediation as NEEDS_VERIFICATION; read the program's
+                     * `cardholder_requirements.level` to name the bar ("requires FULL").
+                     */
+                     | 'NEEDS_VERIFICATION_UPGRADE'
                     /**
                      * A verification came back with a FINAL rejection — only support can
                      * reset it. Never render an actionable "verify now" for this state.
@@ -870,6 +877,14 @@ export declare namespace API {
                         cardholder_id: string | null;
                         /** Fields to collect by hand (submit `missing` vocabulary). */
                         will_require: string[];
+                        /**
+                         * The KYC level this program demands, named for the copy on a
+                         * NEEDS_VERIFICATION_UPGRADE row. Prefer the program's
+                         * `cardholder_requirements.level` when the program is in hand; this is
+                         * the same value carried on the verdict for convenience. Null when the
+                         * program bar could not be read.
+                         */
+                        required_level?: 'minimal' | 'basic' | 'full' | null;
                     };
                     type Response = {
                         success?: boolean;
@@ -919,6 +934,73 @@ export declare namespace API {
                 }
                 export {};
             }
+            export namespace Config {
+                namespace Programs {
+                    type ProgramsRoot = pathsV1Frontend['/frontend/issuing/config/programs'];
+                    type ProgramByIdRoot = pathsV1Frontend['/frontend/issuing/config/programs/{id}'];
+                    /** What each country changes about the cardholder dossier. */
+                    export interface CountryRule {
+                        /** Allowed `gov_id_type` values for a document issued by this country. */
+                        gov_id_types?: string[];
+                        /** Extra fields required when this is the member's nationality. */
+                        required_by_nationality?: string[];
+                        /** Extra fields required when this is the address country. */
+                        required_by_address?: string[];
+                        notes?: string[];
+                    }
+                    /**
+                     * The per-program cardholder KYC bar. Set in the program's vendor config, so it can
+                     * change without a release — read it instead of hardcoding the form. Hand-declared
+                     * until the deployed frontend spec documents it on this route; then it collapses onto
+                     * the autogen field (same forward-compat pattern as the Cardholder wire shape).
+                     */
+                    export interface CardholderRequirements {
+                        /** The KYC level the program demands. */
+                        level: 'minimal' | 'basic' | 'full';
+                        /** Required field names; address fields are dotted (`address.line1`). */
+                        required: string[];
+                        /** Document photos the program requires. */
+                        required_documents: Array<'gov_id_front' | 'gov_id_back' | 'selfie'>;
+                        /** Human-readable constraints the field list cannot express. */
+                        notes?: string[];
+                        /** Per-country overrides, keyed by ISO 3166-1 alpha-3 with a `default` entry. */
+                        country_rules?: Record<string, CountryRule>;
+                    }
+                    type AutogenProgram = NonNullable<ProgramsRoot['get']['responses']['200']['content']['application/json']['data']>[number];
+                    /**
+                     * A program as the frontend config route returns it. `cardholder_requirements` and
+                     * `kyc_rails_id` are hand-added because the deployed spec does not document them yet;
+                     * once it does and the types regenerate, the intersection is a no-op.
+                     */
+                    export type Program = AutogenProgram & {
+                        /** The program's KYC rail; the wallet UI hides programs on a closed/rejected rail. */
+                        kyc_rails_id?: string | null;
+                        cardholder_requirements?: CardholderRequirements;
+                    };
+                    export namespace List {
+                        /** The spec omits `wallet_id`, but the handler reads it to resolve the tariff group. */
+                        export type Request = NonNullable<ProgramsRoot['get']['parameters']['query']> & {
+                            wallet_id?: string;
+                        };
+                        type RawResponse = ProgramsRoot['get']['responses']['200']['content']['application/json'];
+                        export type Response = Omit<RawResponse, 'data'> & {
+                            data?: Program[];
+                        };
+                        export {};
+                    }
+                    export namespace Get {
+                        export type Request = {
+                            id: string;
+                        } & NonNullable<ProgramByIdRoot['get']['parameters']['query']>;
+                        type RawResponse = ProgramByIdRoot['get']['responses']['200']['content']['application/json'];
+                        export type Response = Omit<RawResponse, 'data'> & {
+                            data?: Program;
+                        };
+                        export {};
+                    }
+                    export {};
+                }
+            }
             export {};
         }
     }

package/package.json

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