squarefi-bff-api-module 1.36.81 → 1.36.83

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/api/types/autogen/apiV1External.types.d.ts +7 -6
  2. package/dist/api/types/autogen/apiV1Frontend.types.d.ts +65 -65
  3. package/dist/api/types/autogen/apiV1Legacy.types.d.ts +6 -6
  4. package/dist/api/types/autogen/apiV1Tenant.types.d.ts +31 -48
  5. package/dist/api/types/autogen/apiV2.types.d.ts +2 -2
  6. package/package.json +1 -1
package/dist/api/types/autogen/apiV1External.types.d.ts CHANGED
@@ -1700,8 +1700,8 @@ export interface paths {
1700
1700
  *
1701
1701
  * **Two modes**:
1702
1702
  * - `user_data_id` mode: personal data and KYC documents are seeded from an existing
1703
- * verified user (requires an approved identity/face verification and a Sumsub applicant).
1704
- * Manual fields only fill gaps. The Sumsub files are attached to the draft
1703
+ * verified user (requires an approved identity/face verification and a KYC applicant).
1704
+ * Manual fields only fill gaps. The applicant's KYC files are attached to the draft
1705
1705
  * immediately, so step 2 is usually unnecessary in this mode.
1706
1706
  * - Manual mode: `first_name`, `last_name`, `email`, `phone` are required.
1707
1707
  *
@@ -2055,9 +2055,10 @@ export interface paths {
2055
2055
  head?: never;
2056
2056
  /**
2057
2057
  * Update cardholder
2058
- * @description Updates cardholder information. Email and phone of an Interlace or PhotonPay
2059
- * cardholder are sent to the vendor first; every other field, and every other
2060
- * vendor, is stored locally only.
2058
+ * @description Updates cardholder information. On programs whose card issuer takes contact
2059
+ * updates from the platform (not every issuer does), email and phone are sent to
2060
+ * the issuer first; every other field, and every field on other programs, is
2061
+ * stored locally only. Read the cardholder back from `GET` for the stored value.
2061
2062
  * Same contract as `PATCH /frontend/issuing/cardholders/{cardholder_id}`.
2062
2063
  *
2063
2064
  * **Authentication**: x-api-key header required
@@ -8200,7 +8201,7 @@ export interface components {
8200
8201
  /** Format: uuid */
8201
8202
  transaction_amount_currency?: string | null;
8202
8203
  billing_amount?: number | null;
8203
- /** @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. */
8204
+ /** @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. */
8204
8205
  billing_amount_currency?: string | null;
8205
8206
  fee?: number | null;
8206
8207
  /** Format: uuid */
package/dist/api/types/autogen/apiV1Frontend.types.d.ts CHANGED
@@ -1137,7 +1137,14 @@ export interface paths {
1137
1137
  path?: never;
1138
1138
  cookie?: never;
1139
1139
  };
1140
- /** Download the PDF report of a completed screening */
1140
+ /**
1141
+ * Download the PDF report of a completed screening
1142
+ * @description The report is the analytics provider's own PDF, carrying the provider's
1143
+ * brand. It is fetched from the provider on every download; while the
1144
+ * provider is unreachable the answer is 400 AML_REPORT_PROVIDER_UNAVAILABLE
1145
+ * and the client retries later.
1146
+ *
1147
+ */
1141
1148
  get: {
1142
1149
  parameters: {
1143
1150
  query?: never;
@@ -1160,6 +1167,15 @@ export interface paths {
1160
1167
  "application/pdf": string;
1161
1168
  };
1162
1169
  };
1170
+ /** @description The analytics provider cannot hand the report over right now — retry later (AML_REPORT_PROVIDER_UNAVAILABLE) */
1171
+ 400: {
1172
+ headers: {
1173
+ [name: string]: unknown;
1174
+ };
1175
+ content: {
1176
+ "application/json": components["schemas"]["ErrorResponse"];
1177
+ };
1178
+ };
1163
1179
  /** @description Not found in this wallet (SCREENING_NOT_FOUND) */
1164
1180
  404: {
1165
1181
  headers: {
@@ -5334,7 +5350,7 @@ export interface paths {
5334
5350
  * **Two modes**:
5335
5351
  * - `user_data_id` mode: personal data + KYC documents are seeded from an existing
5336
5352
  * 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).
5337
- * Manual fields only fill gaps. The Sumsub files are attached to the draft
5353
+ * Manual fields only fill gaps. The applicant's KYC files are attached to the draft
5338
5354
  * immediately, so step 2 is usually unnecessary in this mode.
5339
5355
  * - Manual mode: `first_name`, `last_name`, `email`, `phone` are required.
5340
5356
  *
@@ -6356,10 +6372,10 @@ export interface paths {
6356
6372
  cookie?: never;
6357
6373
  };
6358
6374
  /**
6359
- * Initialize Persona KYC session for a wallet
6375
+ * Initialize hosted KYC session for a wallet
6360
6376
  * @deprecated
6361
- * @description Creates a Persona inquiry via the Auth API for the specified wallet and
6362
- * returns the hosted Persona URL. The caller's Bearer token is forwarded to
6377
+ * @description Creates a KYC inquiry via the Auth API for the specified wallet and
6378
+ * returns the hosted verification URL. The caller's Bearer token is forwarded to
6363
6379
  * the Auth API; access requires the caller to be a member of the wallet
6364
6380
  * (ownership/membership is enforced by the standard wallet-access check).
6365
6381
  *
@@ -6382,7 +6398,7 @@ export interface paths {
6382
6398
  };
6383
6399
  requestBody?: never;
6384
6400
  responses: {
6385
- /** @description Persona link generated successfully */
6401
+ /** @description Verification link generated successfully */
6386
6402
  200: {
6387
6403
  headers: {
6388
6404
  [name: string]: unknown;
@@ -6399,21 +6415,19 @@ export interface paths {
6399
6415
  */
6400
6416
  wallet_id: string;
6401
6417
  /**
6402
- * @description Persona inquiry ID returned by the Auth API
6418
+ * @description KYC inquiry ID returned by the Auth API
6403
6419
  * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
6404
6420
  */
6405
6421
  inquiry_id: string;
6406
6422
  /**
6407
- * @description Persona session token, when upstream returns one — otherwise null
6423
+ * @description Session token, when upstream returns one — otherwise null
6408
6424
  * @example null
6409
6425
  */
6410
6426
  session_id: string | null;
6411
6427
  /**
6412
6428
  * Format: uri
6413
- * @description Hosted Persona URL with `inquiry-id` (and `session-token` if `session_id` is present).
6414
- * Base host: `PERSONA_HOSTED_FLOW_URL` env, default `https://withpersona.com/verify`.
6429
+ * @description Hosted verification URL with `inquiry-id` (and `session-token` if `session_id` is present).
6415
6430
  *
6416
- * @example https://withpersona.com/verify?inquiry-id=inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
6417
6431
  */
6418
6432
  url: string;
6419
6433
  };
@@ -6483,10 +6497,10 @@ export interface paths {
6483
6497
  cookie?: never;
6484
6498
  };
6485
6499
  /**
6486
- * Resume Persona KYC session for a wallet
6500
+ * Resume hosted KYC session for a wallet
6487
6501
  * @deprecated
6488
- * @description Resumes an existing Persona inquiry via the Auth API for the specified
6489
- * wallet and returns the hosted Persona URL. The caller's Bearer token is
6502
+ * @description Resumes an existing KYC inquiry via the Auth API for the specified
6503
+ * wallet and returns the hosted verification URL. The caller's Bearer token is
6490
6504
  * forwarded to the Auth API; access requires the caller to be a member of
6491
6505
  * the wallet (ownership/membership is enforced by the standard wallet-access check).
6492
6506
  *
@@ -6509,7 +6523,7 @@ export interface paths {
6509
6523
  };
6510
6524
  requestBody?: never;
6511
6525
  responses: {
6512
- /** @description Persona link generated successfully */
6526
+ /** @description Verification link generated successfully */
6513
6527
  200: {
6514
6528
  headers: {
6515
6529
  [name: string]: unknown;
@@ -6526,21 +6540,19 @@ export interface paths {
6526
6540
  */
6527
6541
  wallet_id: string;
6528
6542
  /**
6529
- * @description Persona inquiry ID returned by the Auth API (same as the one being resumed)
6543
+ * @description KYC inquiry ID returned by the Auth API (same as the one being resumed)
6530
6544
  * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
6531
6545
  */
6532
6546
  inquiry_id: string;
6533
6547
  /**
6534
- * @description Persona session token, when upstream returns one — otherwise null
6548
+ * @description Session token, when upstream returns one — otherwise null
6535
6549
  * @example null
6536
6550
  */
6537
6551
  session_id: string | null;
6538
6552
  /**
6539
6553
  * Format: uri
6540
- * @description Hosted Persona URL with `inquiry-id` (and `session-token` if `session_id` is present).
6541
- * Base host: `PERSONA_HOSTED_FLOW_URL` env, default `https://withpersona.com/verify`.
6554
+ * @description Hosted verification URL with `inquiry-id` (and `session-token` if `session_id` is present).
6542
6555
  *
6543
- * @example https://withpersona.com/verify?inquiry-id=inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
6544
6556
  */
6545
6557
  url: string;
6546
6558
  };
@@ -6614,7 +6626,7 @@ export interface paths {
6614
6626
  /**
6615
6627
  * Initialize KYC verification for a wallet
6616
6628
  * @description Starts a provider-agnostic KYC data-collection flow for the wallet via
6617
- * the Auth API. The KYC provider (Persona, Sumsub, …) is resolved
6629
+ * the Auth API. The KYC provider is resolved
6618
6630
  * internally per tenant — the caller does not choose it. Returns the
6619
6631
  * provider verification id plus an optional short-lived SDK token the
6620
6632
  * client uses to launch the verification. The caller's Bearer token is
@@ -6665,15 +6677,9 @@ export interface paths {
6665
6677
  * @description Echo of the wallet from the path
6666
6678
  */
6667
6679
  wallet_id: string;
6668
- /**
6669
- * @description Provider that handled the flow (e.g. persona, sumsub)
6670
- * @example persona
6671
- */
6680
+ /** @description Provider that handled the flow */
6672
6681
  provider_type: string;
6673
- /**
6674
- * @description Provider verification id — Persona: inquiryId, Sumsub: applicantId
6675
- * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
6676
- */
6682
+ /** @description Provider verification id */
6677
6683
  verification_id: string;
6678
6684
  /** @description Short-lived SDK/session token when the provider mints one — otherwise null */
6679
6685
  verification_token?: string | null;
@@ -6747,8 +6753,9 @@ export interface paths {
6747
6753
  * Resume KYC verification for a wallet
6748
6754
  * @description Resumes an existing provider-agnostic KYC data-collection flow for the
6749
6755
  * wallet via the Auth API. The provider is resolved internally per tenant.
6750
- * `verification_ref` is the provider reference returned by init (Persona:
6751
- * `inquiry_id`, Sumsub: `applicant_id`). The caller's Bearer token is
6756
+ * `verification_ref` is the `verification_id` returned by init (for a session
6757
+ * started through the deprecated `kyc_persona` endpoints, pass its `inquiry_id`).
6758
+ * The caller's Bearer token is
6752
6759
  * forwarded to the Auth API.
6753
6760
  *
6754
6761
  * Provider-agnostic replacement for the deprecated
@@ -6772,10 +6779,9 @@ export interface paths {
6772
6779
  requestBody: {
6773
6780
  content: {
6774
6781
  "application/json": {
6775
- /**
6776
- * @description Provider verification reference (Persona: inquiry_id, Sumsub: applicant_id)
6777
- * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
6778
- */
6782
+ /** @description Provider verification reference: the `verification_id` returned by init, or the
6783
+ * `inquiry_id` of a session started through the deprecated `kyc_persona` endpoints
6784
+ * */
6779
6785
  verification_ref: string;
6780
6786
  };
6781
6787
  };
@@ -6796,15 +6802,9 @@ export interface paths {
6796
6802
  * @description Echo of the wallet from the path
6797
6803
  */
6798
6804
  wallet_id: string;
6799
- /**
6800
- * @description Provider that handled the flow (e.g. persona, sumsub)
6801
- * @example persona
6802
- */
6805
+ /** @description Provider that handled the flow */
6803
6806
  provider_type: string;
6804
- /**
6805
- * @description Provider verification id — Persona: inquiryId, Sumsub: applicantId
6806
- * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
6807
- */
6807
+ /** @description Provider verification id */
6808
6808
  verification_id: string;
6809
6809
  /** @description Short-lived SDK/session token when the provider mints one — otherwise null */
6810
6810
  verification_token?: string | null;
@@ -11700,13 +11700,13 @@ export interface paths {
11700
11700
  get?: never;
11701
11701
  put?: never;
11702
11702
  /**
11703
- * Initialize user-level Sumsub verification
11704
- * @description Starts (or upgrades) the caller's user-level Sumsub verification via
11705
- * the Auth API. The chosen `flow` maps to a tenant-configured Sumsub
11703
+ * Initialize user-level KYC verification
11704
+ * @description Starts (or upgrades) the caller's user-level KYC verification via
11705
+ * the Auth API. The chosen `flow` maps to a tenant-configured verification
11706
11706
  * level — `data` (personal information), `documents` (+identity
11707
11707
  * document) or `face` (+face check) — and the whole level is completed
11708
- * as one WebSDK session. Returns the Sumsub applicant id plus a
11709
- * short-lived WebSDK access token. The caller's Bearer token is
11708
+ * as one SDK session. Returns the provider verification id plus a
11709
+ * short-lived SDK access token. The caller's Bearer token is
11710
11710
  * forwarded to the Auth API.
11711
11711
  *
11712
11712
  * User-scoped: no wallet is involved, unlike
@@ -11749,9 +11749,9 @@ export interface paths {
11749
11749
  * @enum {string}
11750
11750
  */
11751
11751
  flow: "data" | "documents" | "face";
11752
- /** @description Sumsub applicantId */
11752
+ /** @description Provider verification id */
11753
11753
  verification_id: string;
11754
- /** @description Short-lived WebSDK access token — otherwise null */
11754
+ /** @description Short-lived SDK access token — otherwise null */
11755
11755
  verification_token?: string | null;
11756
11756
  };
11757
11757
  };
@@ -11775,7 +11775,7 @@ export interface paths {
11775
11775
  "application/json": components["schemas"]["ErrorResponse"];
11776
11776
  };
11777
11777
  };
11778
- /** @description User verification is not enabled for the tenant (no Sumsub levels configured) */
11778
+ /** @description User verification is not enabled for the tenant (no verification levels configured) */
11779
11779
  404: {
11780
11780
  headers: {
11781
11781
  [name: string]: unknown;
@@ -11820,9 +11820,9 @@ export interface paths {
11820
11820
  get?: never;
11821
11821
  put?: never;
11822
11822
  /**
11823
- * Resume user-level Sumsub verification
11824
- * @description Re-issues the short-lived WebSDK access token for the level the caller
11825
- * is already on (the WebSDK's expirationHandler contract). The caller's
11823
+ * Resume user-level KYC verification
11824
+ * @description Re-issues the short-lived SDK access token for the level the caller
11825
+ * is already on, for the SDK's token-expiry callback. The caller's
11826
11826
  * Bearer token is forwarded to the Auth API.
11827
11827
  *
11828
11828
  * **Authentication**: Bearer token with x-tenant-id header required
@@ -11849,9 +11849,9 @@ export interface paths {
11849
11849
  data: {
11850
11850
  /** @description Always null on resume — the Auth API resumes the current level */
11851
11851
  flow?: string | null;
11852
- /** @description Sumsub applicantId */
11852
+ /** @description Provider verification id */
11853
11853
  verification_id: string;
11854
- /** @description Short-lived WebSDK access token — otherwise null */
11854
+ /** @description Short-lived SDK access token — otherwise null */
11855
11855
  verification_token?: string | null;
11856
11856
  };
11857
11857
  };
@@ -12068,7 +12068,7 @@ export interface paths {
12068
12068
  "application/json": components["schemas"]["ErrorResponse"];
12069
12069
  };
12070
12070
  };
12071
- /** @description The program's vendor is retired (Rail.io) or unsupported — no new accounts can be created on it */
12071
+ /** @description The program's vendor is retired or unsupported — no new accounts can be created on it */
12072
12072
  501: {
12073
12073
  headers: {
12074
12074
  [name: string]: unknown;
@@ -12246,8 +12246,8 @@ export interface paths {
12246
12246
  /**
12247
12247
  * Sync virtual account
12248
12248
  * @description Refreshes the bank account details and deposit instructions from the provider
12249
- * serving the account and updates the local record. Historical Rail.io
12250
- * (RAIL-B / RAIL-C) accounts cannot be refreshed — their stored requisites are
12249
+ * serving the account and updates the local record. Historical accounts of the
12250
+ * retired rail (RAIL-B / RAIL-C) cannot be refreshed — their stored requisites are
12251
12251
  * returned unchanged.
12252
12252
  *
12253
12253
  * **Authentication**: Bearer token with x-tenant-id header required
@@ -12337,8 +12337,8 @@ export interface paths {
12337
12337
  * @description Retrieves detailed information about a specific virtual account.
12338
12338
  * For accounts linked to a provider the requisites are refreshed
12339
12339
  * from the vendor on read unless `skip_sync=true`; a failed refresh falls back to the
12340
- * cached data (still 200). Accounts without a vendor link and historical Rail.io
12341
- * accounts return the stored data.
12340
+ * cached data (still 200). Accounts without a vendor link and historical accounts
12341
+ * of the retired rail return the stored data.
12342
12342
  *
12343
12343
  * **Authentication**: Bearer token with x-tenant-id header required
12344
12344
  *
@@ -14503,7 +14503,7 @@ export interface paths {
14503
14503
  last_name?: string;
14504
14504
  logo_url?: string;
14505
14505
  /**
14506
- * @description Outcome of the member's Sumsub IDENTITY-document step.
14506
+ * @description Outcome of the member's KYC IDENTITY-document step.
14507
14507
  * `APPROVED` is the only value that permits issuing a card to this member.
14508
14508
  *
14509
14509
  * @enum {string}
@@ -15401,7 +15401,7 @@ export interface paths {
15401
15401
  * compliance (`WAITING_ON_REVIEW`); a universal rail is approved on the spot. An application the vendor
15402
15402
  * sent back (`HOLD`, `SOFT_REJECT`) is resubmitted. No body.
15403
15403
  *
15404
- * Refused unless the rail has an onboarding implementation (Rail.io rails never do), takes submissions,
15404
+ * Refused unless the rail has an onboarding implementation (retired rails never do), takes submissions,
15405
15405
  * fits the entity type, and the entity's KYC is `APPROVED` or `WAITING_ON_REVIEW`. On a tenant without KYC
15406
15406
  * only the tenant's default universal rail can be submitted without it.
15407
15407
  *
@@ -15695,7 +15695,7 @@ export interface components {
15695
15695
  total: number;
15696
15696
  has_more: boolean;
15697
15697
  };
15698
- /** @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`. */
15698
+ /** @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`. */
15699
15699
  ExchangeRate: {
15700
15700
  /** @description Absent on a vendor-only pair */
15701
15701
  id?: number;
@@ -16990,7 +16990,7 @@ export interface components {
16990
16990
  transaction_amount_currency?: string | null;
16991
16991
  /** @description Total amount debited (including fees) */
16992
16992
  billing_amount?: number | null;
16993
- /** @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. */
16993
+ /** @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. */
16994
16994
  billing_amount_currency?: string | null;
16995
16995
  fee?: number | null;
16996
16996
  /** Format: uuid */
package/dist/api/types/autogen/apiV1Legacy.types.d.ts CHANGED
@@ -2835,7 +2835,7 @@ export interface paths {
2835
2835
  *
2836
2836
  * L2F orders (L2F_*_OFFRAMP):
2837
2837
  * - virtual_account_id, virtual_account_name
2838
- * - vendor_account_id (Railio account ID)
2838
+ * - vendor_account_id (account ID at the rail provider)
2839
2839
  * - counterparty_destination_id
2840
2840
  * - counterparty_account_id
2841
2841
  * - counterparty_account_name
@@ -2905,7 +2905,7 @@ export interface paths {
2905
2905
  processing_started_at?: string | null;
2906
2906
  /** @description QStash message ID for async workflows */
2907
2907
  qstash_message_id?: string | null;
2908
- /** @description Vendor account ID (Railio, etc.) */
2908
+ /** @description Account ID at the rail provider */
2909
2909
  vendor_account_id?: string | null;
2910
2910
  };
2911
2911
  }[];
@@ -3601,8 +3601,8 @@ export interface components {
3601
3601
  * @description Standardized originator (sender) information for incoming fiat payments,
3602
3602
  * exposed as `order.meta.originator`.
3603
3603
  *
3604
- * The shape is the same whichever rail carried the payment — L2F, Brale,
3605
- * BCB or Delos onramps all normalize into it. Sender details come from the
3604
+ * The shape is the same whichever rail carried the payment — every fiat
3605
+ * onramp rail normalizes into it. Sender details come from the
3606
3606
  * paying bank, so how much is populated varies by rail and by payment:
3607
3607
  * `profile.name` is almost always present, while the sender's address is
3608
3608
  * rarely reported and is often empty for every field.
@@ -3649,12 +3649,12 @@ export interface components {
3649
3649
  crypto_address?: string | null;
3650
3650
  } | null;
3651
3651
  /**
3652
- * @description Payment reference number (rail_reference from Railio)
3652
+ * @description Payment reference number (rail_reference from the rail provider)
3653
3653
  * @example 20251016MMQFMP2U004005
3654
3654
  */
3655
3655
  reference?: string | null;
3656
3656
  /**
3657
- * @description Payment memo/note (rail_originator_memo from Railio)
3657
+ * @description Payment memo/note (rail_originator_memo from the rail provider)
3658
3658
  * @example bfgkp5w
3659
3659
  */
3660
3660
  memo?: string | null;
package/dist/api/types/autogen/apiV1Tenant.types.d.ts CHANGED
@@ -1500,14 +1500,14 @@ export interface paths {
1500
1500
  cookie?: never;
1501
1501
  };
1502
1502
  /**
1503
- * Initialize Persona KYC session for a wallet
1503
+ * Initialize hosted KYC session for a wallet
1504
1504
  * @deprecated
1505
1505
  * @description **Deprecated** — use the provider-agnostic
1506
- * `POST /admin/kyc_verification/{wallet_id}/init` instead. This endpoint is
1507
- * Persona-only and calls a deprecated upstream method.
1506
+ * `POST /admin/kyc_verification/{wallet_id}/init` instead. This endpoint
1507
+ * calls a deprecated upstream method.
1508
1508
  *
1509
- * Creates a Persona inquiry via the Auth API for the specified wallet
1510
- * and returns the hosted Persona URL.
1509
+ * Creates a KYC inquiry via the Auth API for the specified wallet
1510
+ * and returns the hosted verification URL.
1511
1511
  *
1512
1512
  */
1513
1513
  get: {
@@ -1524,7 +1524,7 @@ export interface paths {
1524
1524
  };
1525
1525
  requestBody?: never;
1526
1526
  responses: {
1527
- /** @description Persona link generated successfully */
1527
+ /** @description Verification link generated successfully */
1528
1528
  200: {
1529
1529
  headers: {
1530
1530
  [name: string]: unknown;
@@ -1541,21 +1541,19 @@ export interface paths {
1541
1541
  */
1542
1542
  wallet_id: string;
1543
1543
  /**
1544
- * @description Persona inquiry ID returned by the Auth API
1544
+ * @description KYC inquiry ID returned by the Auth API
1545
1545
  * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
1546
1546
  */
1547
1547
  inquiry_id: string;
1548
1548
  /**
1549
- * @description Persona session token, when upstream returns one — otherwise null
1549
+ * @description Session token, when upstream returns one — otherwise null
1550
1550
  * @example null
1551
1551
  */
1552
1552
  session_id: string | null;
1553
1553
  /**
1554
1554
  * Format: uri
1555
- * @description Hosted Persona URL with `inquiry-id` (and `session-token` if `session_id` is present).
1556
- * Base host: `PERSONA_HOSTED_FLOW_URL` env, default `https://withpersona.com/verify`.
1555
+ * @description Hosted verification URL with `inquiry-id` (and `session-token` if `session_id` is present).
1557
1556
  *
1558
- * @example https://withpersona.com/verify?inquiry-id=inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
1559
1557
  */
1560
1558
  url: string;
1561
1559
  };
@@ -1615,14 +1613,14 @@ export interface paths {
1615
1613
  cookie?: never;
1616
1614
  };
1617
1615
  /**
1618
- * Resume Persona KYC session for a wallet
1616
+ * Resume hosted KYC session for a wallet
1619
1617
  * @deprecated
1620
1618
  * @description **Deprecated** — use the provider-agnostic
1621
- * `POST /admin/kyc_verification/{wallet_id}/resume` instead. This endpoint is
1622
- * Persona-only and calls a deprecated upstream method.
1619
+ * `POST /admin/kyc_verification/{wallet_id}/resume` instead. This endpoint
1620
+ * calls a deprecated upstream method.
1623
1621
  *
1624
- * Resumes an existing Persona inquiry via the Auth API for the specified wallet
1625
- * and returns the hosted Persona URL.
1622
+ * Resumes an existing KYC inquiry via the Auth API for the specified wallet
1623
+ * and returns the hosted verification URL.
1626
1624
  *
1627
1625
  */
1628
1626
  get: {
@@ -1639,7 +1637,7 @@ export interface paths {
1639
1637
  };
1640
1638
  requestBody?: never;
1641
1639
  responses: {
1642
- /** @description Persona link generated successfully */
1640
+ /** @description Verification link generated successfully */
1643
1641
  200: {
1644
1642
  headers: {
1645
1643
  [name: string]: unknown;
@@ -1656,21 +1654,19 @@ export interface paths {
1656
1654
  */
1657
1655
  wallet_id: string;
1658
1656
  /**
1659
- * @description Persona inquiry ID returned by the Auth API (same as the one being resumed)
1657
+ * @description KYC inquiry ID returned by the Auth API (same as the one being resumed)
1660
1658
  * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
1661
1659
  */
1662
1660
  inquiry_id: string;
1663
1661
  /**
1664
- * @description Persona session token, when upstream returns one — otherwise null
1662
+ * @description Session token, when upstream returns one — otherwise null
1665
1663
  * @example null
1666
1664
  */
1667
1665
  session_id: string | null;
1668
1666
  /**
1669
1667
  * Format: uri
1670
- * @description Hosted Persona URL with `inquiry-id` (and `session-token` if `session_id` is present).
1671
- * Base host: `PERSONA_HOSTED_FLOW_URL` env, default `https://withpersona.com/verify`.
1668
+ * @description Hosted verification URL with `inquiry-id` (and `session-token` if `session_id` is present).
1672
1669
  *
1673
- * @example https://withpersona.com/verify?inquiry-id=inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
1674
1670
  */
1675
1671
  url: string;
1676
1672
  };
@@ -1734,7 +1730,7 @@ export interface paths {
1734
1730
  /**
1735
1731
  * Initialize KYC verification for a wallet
1736
1732
  * @description Starts a provider-agnostic KYC data-collection flow for the wallet. The
1737
- * KYC provider (Persona, Sumsub, …) is resolved internally per tenant — the
1733
+ * KYC provider is resolved internally per tenant — the
1738
1734
  * caller does not choose it. Returns the provider verification id plus an
1739
1735
  * optional short-lived SDK token and provider-specific payload the client
1740
1736
  * uses to launch the verification.
@@ -1780,15 +1776,9 @@ export interface paths {
1780
1776
  * @description Echo of the wallet from the path
1781
1777
  */
1782
1778
  wallet_id: string;
1783
- /**
1784
- * @description Provider that handled the flow (e.g. persona, sumsub)
1785
- * @example persona
1786
- */
1779
+ /** @description Provider that handled the flow */
1787
1780
  provider_type: string;
1788
- /**
1789
- * @description Provider verification id — Persona: inquiryId, Sumsub: applicantId
1790
- * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
1791
- */
1781
+ /** @description Provider verification id */
1792
1782
  verification_id: string;
1793
1783
  /** @description Short-lived SDK/session token when the provider mints one — otherwise null */
1794
1784
  verification_token?: string | null;
@@ -1863,8 +1853,8 @@ export interface paths {
1863
1853
  * Resume KYC verification for a wallet
1864
1854
  * @description Resumes an existing provider-agnostic KYC data-collection flow for the
1865
1855
  * wallet. The provider is resolved internally per tenant. `verification_ref`
1866
- * is the provider reference returned by init (Persona: `inquiry_id`,
1867
- * Sumsub: `applicant_id`).
1856
+ * is the `verification_id` returned by init (for a session started through
1857
+ * the deprecated `kyc_persona` endpoints, pass its `inquiry_id`).
1868
1858
  *
1869
1859
  * Provider-agnostic replacement for the deprecated
1870
1860
  * `POST/GET /admin/kyc_persona/{wallet_id}/resume`.
@@ -1883,10 +1873,9 @@ export interface paths {
1883
1873
  requestBody: {
1884
1874
  content: {
1885
1875
  "application/json": {
1886
- /**
1887
- * @description Provider verification reference (Persona: inquiry_id, Sumsub: applicant_id)
1888
- * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
1889
- */
1876
+ /** @description Provider verification reference: the `verification_id` returned by init, or the
1877
+ * `inquiry_id` of a session started through the deprecated `kyc_persona` endpoints
1878
+ * */
1890
1879
  verification_ref: string;
1891
1880
  };
1892
1881
  };
@@ -1907,17 +1896,11 @@ export interface paths {
1907
1896
  * @description Echo of the wallet from the path
1908
1897
  */
1909
1898
  wallet_id: string;
1910
- /**
1911
- * @description Provider that handled the flow (e.g. persona, sumsub)
1912
- * @example persona
1913
- */
1899
+ /** @description Provider that handled the flow */
1914
1900
  provider_type: string;
1915
- /**
1916
- * @description Provider verification id — Persona: inquiryId, Sumsub: applicantId
1917
- * @example inq_ABDNxhp9ZzD3yehivCbMVvmjwh5g5r
1918
- */
1901
+ /** @description Provider verification id */
1919
1902
  verification_id: string;
1920
- /** @description Short-lived SDK/session token — Persona: sessionToken, Sumsub: accessToken — otherwise null */
1903
+ /** @description Short-lived SDK/session token, when the provider issues one — otherwise null */
1921
1904
  verification_token?: string | null;
1922
1905
  /** @description Provider-specific payload forwarded to the client SDK */
1923
1906
  provider_data?: {
@@ -5851,8 +5834,8 @@ export interface paths {
5851
5834
  *
5852
5835
  * **Two modes**:
5853
5836
  * - `user_data_id` mode: personal data + KYC documents are seeded from an existing
5854
- * verified user (approved identity/face verification + Sumsub applicant required).
5855
- * Manual fields only fill gaps; the Sumsub files are attached immediately.
5837
+ * verified user (approved identity/face verification + KYC applicant required).
5838
+ * Manual fields only fill gaps; the applicant's KYC files are attached immediately.
5856
5839
  * - Manual mode: `first_name`, `last_name`, `email`, `phone` are required.
5857
5840
  *
5858
5841
  */
package/dist/api/types/autogen/apiV2.types.d.ts CHANGED
@@ -658,7 +658,7 @@ export interface paths {
658
658
  };
659
659
  get?: never;
660
660
  put?: never;
661
- /** Init user-level Sumsub verification (data / documents / face flow) */
661
+ /** Init user-level KYC verification (data / documents / face flow) */
662
662
  post: operations["UserVerificationController_init"];
663
663
  delete?: never;
664
664
  options?: never;
@@ -675,7 +675,7 @@ export interface paths {
675
675
  };
676
676
  get?: never;
677
677
  put?: never;
678
- /** Re-issue the WebSDK access token for the current level */
678
+ /** Re-issue the SDK access token for the current level */
679
679
  post: operations["UserVerificationController_resume"];
680
680
  delete?: never;
681
681
  options?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.36.81",
3
+ "version": "1.36.83",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",