squarefi-bff-api-module 1.36.80 → 1.36.82

package/README.md

@@ -210,7 +210,7 @@ const publicUrl = getPublicUrl(path);
 | **developer**       | Vendor & API key management                                         |
 | **exchange**        | Exchange rates per order type / currency                            |
 | **issuing**         | Virtual & physical cards, limits, controls, transactions            |
-| **kyc**             | KYC entities & data collection, Sumsub flows, rails & forms         |
+| **kyc**             | KYC entities & data collection, provider flows, rails & forms       |
 | **list**            | Static system lists – currencies, chains, countries                 |
 | **orders**          | Create / calculate orders (including internal transfer)             |
 | **tenants**         | Tenant configuration                                                |

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

@@ -1700,8 +1700,8 @@ export interface paths {
          *
          *     **Two modes**:
          *     - `user_data_id` mode: personal data and KYC documents are seeded from an existing
-         *       verified user (requires an approved identity/face verification and a Sumsub applicant).
-         *       Manual fields only fill gaps. The Sumsub files are attached to the draft
+         *       verified user (requires an approved identity/face verification and a KYC applicant).
+         *       Manual fields only fill gaps. The applicant's KYC files are attached to the draft
          *       immediately, so step 2 is usually unnecessary in this mode.
          *     - Manual mode: `first_name`, `last_name`, `email`, `phone` are required.
          *
@@ -2055,9 +2055,10 @@ export interface paths {
         head?: never;
         /**
          * Update cardholder
-         * @description Updates cardholder information. Email and phone of an Interlace or PhotonPay
-         *     cardholder are sent to the vendor first; every other field, and every other
-         *     vendor, is stored locally only.
+         * @description Updates cardholder information. On programs whose card issuer takes contact
+         *     updates from the platform (not every issuer does), email and phone are sent to
+         *     the issuer first; every other field, and every field on other programs, is
+         *     stored locally only. Read the cardholder back from `GET` for the stored value.
          *     Same contract as `PATCH /frontend/issuing/cardholders/{cardholder_id}`.
          *
          *     **Authentication**: x-api-key header required
@@ -8200,7 +8201,7 @@ export interface components {
             /** Format: uuid */
             transaction_amount_currency?: string | null;
             billing_amount?: number | null;
-            /** @description Currency of `billing_amount`. Not uniform across rails: a currency uuid on most orders, an ISO code (e.g. `EUR`) on L2F off-ramps, the destination currency uuid on BC/DLS on-ramps. Use the order's `from_uuid` for the debited currency. */
+            /** @description Currency of `billing_amount`. Not uniform across rails: a currency uuid on most orders, an ISO code (e.g. `EUR`) on `L2F_*` off-ramps, the destination currency uuid on `BC1_*`/`BC3_*`/`DLS_*` on-ramps. Use the order's `from_uuid` for the debited currency. */
             billing_amount_currency?: string | null;
             fee?: number | null;
             /** Format: uuid */

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

@@ -1137,7 +1137,14 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Download the PDF report of a completed screening */
+        /**
+         * Download the PDF report of a completed screening
+         * @description The report is the analytics provider's own PDF, carrying the provider's
+         *     brand. It is fetched from the provider on every download; while the
+         *     provider is unreachable the answer is 400 AML_REPORT_PROVIDER_UNAVAILABLE
+         *     and the client retries later.
+         *
+         */
         get: {
             parameters: {
                 query?: never;
@@ -1160,6 +1167,15 @@ export interface paths {
                         "application/pdf": string;
                     };
                 };
+                /** @description The analytics provider cannot hand the report over right now — retry later (AML_REPORT_PROVIDER_UNAVAILABLE) */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
                 /** @description Not found in this wallet (SCREENING_NOT_FOUND) */
                 404: {
                     headers: {
@@ -5334,7 +5350,7 @@ export interface paths {
          *     **Two modes**:
          *     - `user_data_id` mode: personal data + KYC documents are seeded from an existing
          *       verified user. An approved identity/face verification plus a KYC applicant are required only when the program's KYC level needs document photos; otherwise any active member without a final rejection can be seeded (documents are then uploaded by hand).
-         *       Manual fields only fill gaps. The Sumsub files are attached to the draft
+         *       Manual fields only fill gaps. The applicant's KYC files are attached to the draft
          *       immediately, so step 2 is usually unnecessary in this mode.
          *     - Manual mode: `first_name`, `last_name`, `email`, `phone` are required.
          *
@@ -6356,10 +6372,10 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Initialize Persona KYC session for a wallet
+         * Initialize hosted KYC session for a wallet
          * @deprecated
-         * @description Creates a Persona inquiry via the Auth API for the specified wallet and
-         *     returns the hosted Persona URL. The caller's Bearer token is forwarded to
+         * @description Creates a KYC inquiry via the Auth API for the specified wallet and
+         *     returns the hosted verification URL. The caller's Bearer token is forwarded to
          *     the Auth API; access requires the caller to be a member of the wallet
          *     (ownership/membership is enforced by the standard wallet-access check).
          *
@@ -6382,7 +6398,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description Persona link generated successfully */
+                /** @description Verification link generated successfully */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -6399,21 +6415,19 @@ export interface paths {
                                  */
                                 wallet_id: string;
                                 /**
-                                 * @description Persona inquiry ID returned by the Auth API
+                                 * @description KYC inquiry ID returned by the Auth API
                                  * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
                                  */
                                 inquiry_id: string;
                                 /**
-                                 * @description Persona session token, when upstream returns one — otherwise null
+                                 * @description Session token, when upstream returns one — otherwise null
                                  * @example null
                                  */
                                 session_id: string | null;
                                 /**
                                  * Format: uri
-                                 * @description Hosted Persona URL with `inquiry-id` (and `session-token` if `session_id` is present).
-                                 *     Base host: `PERSONA_HOSTED_FLOW_URL` env, default `https://withpersona.com/verify`.
+                                 * @description Hosted verification URL with `inquiry-id` (and `session-token` if `session_id` is present).
                                  *
-                                 * @example https://withpersona.com/verify?inquiry-id=inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
                                  */
                                 url: string;
                             };
@@ -6483,10 +6497,10 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Resume Persona KYC session for a wallet
+         * Resume hosted KYC session for a wallet
          * @deprecated
-         * @description Resumes an existing Persona inquiry via the Auth API for the specified
-         *     wallet and returns the hosted Persona URL. The caller's Bearer token is
+         * @description Resumes an existing KYC inquiry via the Auth API for the specified
+         *     wallet and returns the hosted verification URL. The caller's Bearer token is
          *     forwarded to the Auth API; access requires the caller to be a member of
          *     the wallet (ownership/membership is enforced by the standard wallet-access check).
          *
@@ -6509,7 +6523,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description Persona link generated successfully */
+                /** @description Verification link generated successfully */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -6526,21 +6540,19 @@ export interface paths {
                                  */
                                 wallet_id: string;
                                 /**
-                                 * @description Persona inquiry ID returned by the Auth API (same as the one being resumed)
+                                 * @description KYC inquiry ID returned by the Auth API (same as the one being resumed)
                                  * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
                                  */
                                 inquiry_id: string;
                                 /**
-                                 * @description Persona session token, when upstream returns one — otherwise null
+                                 * @description Session token, when upstream returns one — otherwise null
                                  * @example null
                                  */
                                 session_id: string | null;
                                 /**
                                  * Format: uri
-                                 * @description Hosted Persona URL with `inquiry-id` (and `session-token` if `session_id` is present).
-                                 *     Base host: `PERSONA_HOSTED_FLOW_URL` env, default `https://withpersona.com/verify`.
+                                 * @description Hosted verification URL with `inquiry-id` (and `session-token` if `session_id` is present).
                                  *
-                                 * @example https://withpersona.com/verify?inquiry-id=inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
                                  */
                                 url: string;
                             };
@@ -6614,7 +6626,7 @@ export interface paths {
         /**
          * Initialize KYC verification for a wallet
          * @description Starts a provider-agnostic KYC data-collection flow for the wallet via
-         *     the Auth API. The KYC provider (Persona, Sumsub, …) is resolved
+         *     the Auth API. The KYC provider is resolved
          *     internally per tenant — the caller does not choose it. Returns the
          *     provider verification id plus an optional short-lived SDK token the
          *     client uses to launch the verification. The caller's Bearer token is
@@ -6665,15 +6677,9 @@ export interface paths {
                                  * @description Echo of the wallet from the path
                                  */
                                 wallet_id: string;
-                                /**
-                                 * @description Provider that handled the flow (e.g. persona, sumsub)
-                                 * @example persona
-                                 */
+                                /** @description Provider that handled the flow */
                                 provider_type: string;
-                                /**
-                                 * @description Provider verification id — Persona: inquiryId, Sumsub: applicantId
-                                 * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
-                                 */
+                                /** @description Provider verification id */
                                 verification_id: string;
                                 /** @description Short-lived SDK/session token when the provider mints one — otherwise null */
                                 verification_token?: string | null;
@@ -6747,8 +6753,9 @@ export interface paths {
          * Resume KYC verification for a wallet
          * @description Resumes an existing provider-agnostic KYC data-collection flow for the
          *     wallet via the Auth API. The provider is resolved internally per tenant.
-         *     `verification_ref` is the provider reference returned by init (Persona:
-         *     `inquiry_id`, Sumsub: `applicant_id`). The caller's Bearer token is
+         *     `verification_ref` is the `verification_id` returned by init (for a session
+         *     started through the deprecated `kyc_persona` endpoints, pass its `inquiry_id`).
+         *     The caller's Bearer token is
          *     forwarded to the Auth API.
          *
          *     Provider-agnostic replacement for the deprecated
@@ -6772,10 +6779,9 @@ export interface paths {
             requestBody: {
                 content: {
                     "application/json": {
-                        /**
-                         * @description Provider verification reference (Persona: inquiry_id, Sumsub: applicant_id)
-                         * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
-                         */
+                        /** @description Provider verification reference: the `verification_id` returned by init, or the
+                         *     `inquiry_id` of a session started through the deprecated `kyc_persona` endpoints
+                         *      */
                         verification_ref: string;
                     };
                 };
@@ -6796,15 +6802,9 @@ export interface paths {
                                  * @description Echo of the wallet from the path
                                  */
                                 wallet_id: string;
-                                /**
-                                 * @description Provider that handled the flow (e.g. persona, sumsub)
-                                 * @example persona
-                                 */
+                                /** @description Provider that handled the flow */
                                 provider_type: string;
-                                /**
-                                 * @description Provider verification id — Persona: inquiryId, Sumsub: applicantId
-                                 * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
-                                 */
+                                /** @description Provider verification id */
                                 verification_id: string;
                                 /** @description Short-lived SDK/session token when the provider mints one — otherwise null */
                                 verification_token?: string | null;
@@ -11700,13 +11700,13 @@ export interface paths {
         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
+         * Initialize user-level KYC verification
+         * @description Starts (or upgrades) the caller's user-level KYC verification via
+         *     the Auth API. The chosen `flow` maps to a tenant-configured verification
          *     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
+         *     as one SDK session. Returns the provider verification id plus a
+         *     short-lived SDK access token. The caller's Bearer token is
          *     forwarded to the Auth API.
          *
          *     User-scoped: no wallet is involved, unlike
@@ -11749,9 +11749,9 @@ export interface paths {
                                  * @enum {string}
                                  */
                                 flow: "data" | "documents" | "face";
-                                /** @description Sumsub applicantId */
+                                /** @description Provider verification id */
                                 verification_id: string;
-                                /** @description Short-lived WebSDK access token — otherwise null */
+                                /** @description Short-lived SDK access token — otherwise null */
                                 verification_token?: string | null;
                             };
                         };
@@ -11775,7 +11775,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
-                /** @description User verification is not enabled for the tenant (no Sumsub levels configured) */
+                /** @description User verification is not enabled for the tenant (no verification levels configured) */
                 404: {
                     headers: {
                         [name: string]: unknown;
@@ -11820,9 +11820,9 @@ export interface paths {
         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
+         * Resume user-level KYC verification
+         * @description Re-issues the short-lived SDK access token for the level the caller
+         *     is already on, for the SDK's token-expiry callback. The caller's
          *     Bearer token is forwarded to the Auth API.
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
@@ -11849,9 +11849,9 @@ export interface paths {
                             data: {
                                 /** @description Always null on resume — the Auth API resumes the current level */
                                 flow?: string | null;
-                                /** @description Sumsub applicantId */
+                                /** @description Provider verification id */
                                 verification_id: string;
-                                /** @description Short-lived WebSDK access token — otherwise null */
+                                /** @description Short-lived SDK access token — otherwise null */
                                 verification_token?: string | null;
                             };
                         };
@@ -12068,7 +12068,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
-                /** @description The program's vendor is retired (Rail.io) or unsupported — no new accounts can be created on it */
+                /** @description The program's vendor is retired or unsupported — no new accounts can be created on it */
                 501: {
                     headers: {
                         [name: string]: unknown;
@@ -12246,8 +12246,8 @@ export interface paths {
         /**
          * Sync virtual account
          * @description Refreshes the bank account details and deposit instructions from the provider
-         *     serving the account and updates the local record. Historical Rail.io
-         *     (RAIL-B / RAIL-C) accounts cannot be refreshed — their stored requisites are
+         *     serving the account and updates the local record. Historical accounts of the
+         *     retired rail (RAIL-B / RAIL-C) cannot be refreshed — their stored requisites are
          *     returned unchanged.
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
@@ -12337,8 +12337,8 @@ export interface paths {
          * @description Retrieves detailed information about a specific virtual account.
          *     For accounts linked to a provider the requisites are refreshed
          *     from the vendor on read unless `skip_sync=true`; a failed refresh falls back to the
-         *     cached data (still 200). Accounts without a vendor link and historical Rail.io
-         *     accounts return the stored data.
+         *     cached data (still 200). Accounts without a vendor link and historical accounts
+         *     of the retired rail return the stored data.
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
@@ -14503,7 +14503,7 @@ export interface paths {
                                     last_name?: string;
                                     logo_url?: string;
                                     /**
-                                     * @description Outcome of the member's Sumsub IDENTITY-document step.
+                                     * @description Outcome of the member's KYC IDENTITY-document step.
                                      *     `APPROVED` is the only value that permits issuing a card to this member.
                                      *
                                      * @enum {string}
@@ -15401,7 +15401,7 @@ export interface paths {
          *     compliance (`WAITING_ON_REVIEW`); a universal rail is approved on the spot. An application the vendor
          *     sent back (`HOLD`, `SOFT_REJECT`) is resubmitted. No body.
          *
-         *     Refused unless the rail has an onboarding implementation (Rail.io rails never do), takes submissions,
+         *     Refused unless the rail has an onboarding implementation (retired rails never do), takes submissions,
          *     fits the entity type, and the entity's KYC is `APPROVED` or `WAITING_ON_REVIEW`. On a tenant without KYC
          *     only the tenant's default universal rail can be submitted without it.
          *
@@ -15695,7 +15695,7 @@ export interface components {
             total: number;
             has_more: boolean;
         };
-        /** @description A currency pair enabled for the tenant: the `exchange_rates` row with the tenant FX spread applied. Pairs a vendor rate table adds for its own order types (Reap Payments, `RPP_*`) have no `id`. */
+        /** @description A currency pair enabled for the tenant: the `exchange_rates` row with the tenant FX spread applied. Pairs a vendor rate table adds for its own order types (`RPP_*`) have no `id`. */
         ExchangeRate: {
             /** @description Absent on a vendor-only pair */
             id?: number;
@@ -16990,7 +16990,7 @@ export interface components {
             transaction_amount_currency?: string | null;
             /** @description Total amount debited (including fees) */
             billing_amount?: number | null;
-            /** @description Currency of `billing_amount`. Not uniform across rails: a currency uuid on most orders, an ISO code (e.g. `EUR`) on L2F off-ramps, the destination currency uuid on BC/DLS on-ramps. Use the order's `from_uuid` for the debited currency. */
+            /** @description Currency of `billing_amount`. Not uniform across rails: a currency uuid on most orders, an ISO code (e.g. `EUR`) on `L2F_*` off-ramps, the destination currency uuid on `BC1_*`/`BC3_*`/`DLS_*` on-ramps. Use the order's `from_uuid` for the debited currency. */
             billing_amount_currency?: string | null;
             fee?: number | null;
             /** Format: uuid */

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

@@ -2835,7 +2835,7 @@ export interface paths {
                                  *
                                  *     L2F orders (L2F_*_OFFRAMP):
                                  *     - virtual_account_id, virtual_account_name
-                                 *     - vendor_account_id (Railio account ID)
+                                 *     - vendor_account_id (account ID at the rail provider)
                                  *     - counterparty_destination_id
                                  *     - counterparty_account_id
                                  *     - counterparty_account_name
@@ -2905,7 +2905,7 @@ export interface paths {
                                     processing_started_at?: string | null;
                                     /** @description QStash message ID for async workflows */
                                     qstash_message_id?: string | null;
-                                    /** @description Vendor account ID (Railio, etc.) */
+                                    /** @description Account ID at the rail provider */
                                     vendor_account_id?: string | null;
                                 };
                             }[];
@@ -3601,8 +3601,8 @@ export interface components {
          * @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
+         *     The shape is the same whichever rail carried the payment — every fiat
+         *     onramp rail normalizes 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.
@@ -3649,12 +3649,12 @@ export interface components {
                 crypto_address?: string | null;
             } | null;
             /**
-             * @description Payment reference number (rail_reference from Railio)
+             * @description Payment reference number (rail_reference from the rail provider)
              * @example 20251016MMQFMP2U004005
              */
             reference?: string | null;
             /**
-             * @description Payment memo/note (rail_originator_memo from Railio)
+             * @description Payment memo/note (rail_originator_memo from the rail provider)
              * @example bfgkp5w
              */
             memo?: string | null;

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

@@ -1500,14 +1500,14 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Initialize Persona KYC session for a wallet
+         * Initialize hosted KYC session for a wallet
          * @deprecated
          * @description **Deprecated** — use the provider-agnostic
-         *     `POST /admin/kyc_verification/{wallet_id}/init` instead. This endpoint is
-         *     Persona-only and calls a deprecated upstream method.
+         *     `POST /admin/kyc_verification/{wallet_id}/init` instead. This endpoint
+         *     calls a deprecated upstream method.
          *
-         *     Creates a Persona inquiry via the Auth API for the specified wallet
-         *     and returns the hosted Persona URL.
+         *     Creates a KYC inquiry via the Auth API for the specified wallet
+         *     and returns the hosted verification URL.
          *
          */
         get: {
@@ -1524,7 +1524,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description Persona link generated successfully */
+                /** @description Verification link generated successfully */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -1541,21 +1541,19 @@ export interface paths {
                                  */
                                 wallet_id: string;
                                 /**
-                                 * @description Persona inquiry ID returned by the Auth API
+                                 * @description KYC inquiry ID returned by the Auth API
                                  * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
                                  */
                                 inquiry_id: string;
                                 /**
-                                 * @description Persona session token, when upstream returns one — otherwise null
+                                 * @description Session token, when upstream returns one — otherwise null
                                  * @example null
                                  */
                                 session_id: string | null;
                                 /**
                                  * Format: uri
-                                 * @description Hosted Persona URL with `inquiry-id` (and `session-token` if `session_id` is present).
-                                 *     Base host: `PERSONA_HOSTED_FLOW_URL` env, default `https://withpersona.com/verify`.
+                                 * @description Hosted verification URL with `inquiry-id` (and `session-token` if `session_id` is present).
                                  *
-                                 * @example https://withpersona.com/verify?inquiry-id=inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
                                  */
                                 url: string;
                             };
@@ -1615,14 +1613,14 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Resume Persona KYC session for a wallet
+         * Resume hosted KYC session for a wallet
          * @deprecated
          * @description **Deprecated** — use the provider-agnostic
-         *     `POST /admin/kyc_verification/{wallet_id}/resume` instead. This endpoint is
-         *     Persona-only and calls a deprecated upstream method.
+         *     `POST /admin/kyc_verification/{wallet_id}/resume` instead. This endpoint
+         *     calls a deprecated upstream method.
          *
-         *     Resumes an existing Persona inquiry via the Auth API for the specified wallet
-         *     and returns the hosted Persona URL.
+         *     Resumes an existing KYC inquiry via the Auth API for the specified wallet
+         *     and returns the hosted verification URL.
          *
          */
         get: {
@@ -1639,7 +1637,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description Persona link generated successfully */
+                /** @description Verification link generated successfully */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -1656,21 +1654,19 @@ export interface paths {
                                  */
                                 wallet_id: string;
                                 /**
-                                 * @description Persona inquiry ID returned by the Auth API (same as the one being resumed)
+                                 * @description KYC inquiry ID returned by the Auth API (same as the one being resumed)
                                  * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
                                  */
                                 inquiry_id: string;
                                 /**
-                                 * @description Persona session token, when upstream returns one — otherwise null
+                                 * @description Session token, when upstream returns one — otherwise null
                                  * @example null
                                  */
                                 session_id: string | null;
                                 /**
                                  * Format: uri
-                                 * @description Hosted Persona URL with `inquiry-id` (and `session-token` if `session_id` is present).
-                                 *     Base host: `PERSONA_HOSTED_FLOW_URL` env, default `https://withpersona.com/verify`.
+                                 * @description Hosted verification URL with `inquiry-id` (and `session-token` if `session_id` is present).
                                  *
-                                 * @example https://withpersona.com/verify?inquiry-id=inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
                                  */
                                 url: string;
                             };
@@ -1734,7 +1730,7 @@ export interface paths {
         /**
          * Initialize KYC verification for a wallet
          * @description Starts a provider-agnostic KYC data-collection flow for the wallet. The
-         *     KYC provider (Persona, Sumsub, …) is resolved internally per tenant — the
+         *     KYC provider is resolved internally per tenant — the
          *     caller does not choose it. Returns the provider verification id plus an
          *     optional short-lived SDK token and provider-specific payload the client
          *     uses to launch the verification.
@@ -1780,15 +1776,9 @@ export interface paths {
                                  * @description Echo of the wallet from the path
                                  */
                                 wallet_id: string;
-                                /**
-                                 * @description Provider that handled the flow (e.g. persona, sumsub)
-                                 * @example persona
-                                 */
+                                /** @description Provider that handled the flow */
                                 provider_type: string;
-                                /**
-                                 * @description Provider verification id — Persona: inquiryId, Sumsub: applicantId
-                                 * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
-                                 */
+                                /** @description Provider verification id */
                                 verification_id: string;
                                 /** @description Short-lived SDK/session token when the provider mints one — otherwise null */
                                 verification_token?: string | null;
@@ -1863,8 +1853,8 @@ export interface paths {
          * Resume KYC verification for a wallet
          * @description Resumes an existing provider-agnostic KYC data-collection flow for the
          *     wallet. The provider is resolved internally per tenant. `verification_ref`
-         *     is the provider reference returned by init (Persona: `inquiry_id`,
-         *     Sumsub: `applicant_id`).
+         *     is the `verification_id` returned by init (for a session started through
+         *     the deprecated `kyc_persona` endpoints, pass its `inquiry_id`).
          *
          *     Provider-agnostic replacement for the deprecated
          *     `POST/GET /admin/kyc_persona/{wallet_id}/resume`.
@@ -1883,10 +1873,9 @@ export interface paths {
             requestBody: {
                 content: {
                     "application/json": {
-                        /**
-                         * @description Provider verification reference (Persona: inquiry_id, Sumsub: applicant_id)
-                         * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
-                         */
+                        /** @description Provider verification reference: the `verification_id` returned by init, or the
+                         *     `inquiry_id` of a session started through the deprecated `kyc_persona` endpoints
+                         *      */
                         verification_ref: string;
                     };
                 };
@@ -1907,17 +1896,11 @@ export interface paths {
                                  * @description Echo of the wallet from the path
                                  */
                                 wallet_id: string;
-                                /**
-                                 * @description Provider that handled the flow (e.g. persona, sumsub)
-                                 * @example persona
-                                 */
+                                /** @description Provider that handled the flow */
                                 provider_type: string;
-                                /**
-                                 * @description Provider verification id — Persona: inquiryId, Sumsub: applicantId
-                                 * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
-                                 */
+                                /** @description Provider verification id */
                                 verification_id: string;
-                                /** @description Short-lived SDK/session token — Persona: sessionToken, Sumsub: accessToken — otherwise null */
+                                /** @description Short-lived SDK/session token, when the provider issues one — otherwise null */
                                 verification_token?: string | null;
                                 /** @description Provider-specific payload forwarded to the client SDK */
                                 provider_data?: {
@@ -5851,8 +5834,8 @@ export interface paths {
          *
          *     **Two modes**:
          *     - `user_data_id` mode: personal data + KYC documents are seeded from an existing
-         *       verified user (approved identity/face verification + Sumsub applicant required).
-         *       Manual fields only fill gaps; the Sumsub files are attached immediately.
+         *       verified user (approved identity/face verification + KYC applicant required).
+         *       Manual fields only fill gaps; the applicant's KYC files are attached immediately.
          *     - Manual mode: `first_name`, `last_name`, `email`, `phone` are required.
          *
          */

package/dist/api/user.js

@@ -15,12 +15,12 @@ export const user = {
         },
     },
     verification: {
-        // Starts (or moves up) the per-user Sumsub level for the requested step and returns the WebSDK
+        // Starts (or moves up) the per-user KYC level for the requested step and returns the SDK
         // credentials. Resolves 404 when the tenant has no level configured for the step. Step results
         // land on user-data (`identity_verification_status` / `face_verification_status`), so poll
-        // `user.userData.get()` after the WebSDK reports completion.
+        // `user.userData.get()` after the SDK reports completion.
         init: (data) => apiClientV2.postRequest('/user/verification/init', { data }),
-        // Re-issues the WebSDK access token for the level the user is already on; 404 when the user has
+        // Re-issues the SDK access token for the level the user is already on; 404 when the user has
         // never been initialized.
         resume: () => apiClientV2.postRequest('/user/verification/resume'),
     },

package/package.json

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