rebilly-js-sdk 62.243.7 → 62.245.0

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.
@@ -592,6 +592,11 @@ declare namespace rebilly {
592
592
  type PutKycSettingsResponse = operations['PutKycSettings']['responses']['200']['content']['application/json']
593
593
  type PutKycSettingsResponsePromise = Promise<{fields: PutKycSettingsResponse}>
594
594
 
595
+ type PostResolveScopedKycSettingsRequest = operations['PostResolveScopedKycSettings']['requestBody']['content']['application/json']
596
+ type CreateResolveScopedKycSettingsRequest = { id?: string, data: PostResolveScopedKycSettingsRequest, expand?: string }
597
+ type PostResolveScopedKycSettingsResponse = operations['PostResolveScopedKycSettings']['responses']['200']['content']['application/json']
598
+ type PostResolveScopedKycSettingsResponsePromise = Promise<{fields: PostResolveScopedKycSettingsResponse}>
599
+
595
600
  type GetPasswordTokenCollectionRequest = operations['GetPasswordTokenCollection']['parameters']["query"] & (operations['GetPasswordTokenCollection']['parameters'] extends {path: {}} ? operations['GetPasswordTokenCollection']['parameters']["path"] : {})
596
601
 
597
602
  type GetPasswordTokenCollectionResponse = operations['GetPasswordTokenCollection']['responses']['200']['content']['application/json'][0]
@@ -3561,6 +3566,13 @@ export interface corePaths {
3561
3566
  /** Updates KYC settings. */
3562
3567
  put: operations["PutKycSettings"];
3563
3568
  };
3569
+ "/kyc-settings/resolve-scoped-settings": {
3570
+ /**
3571
+ * Resolves document subtype restrictions for a website.
3572
+ * When `documents` are provided, the response contains restrictions that match the document types, subtypes, and face proof requirements.
3573
+ */
3574
+ post: operations["PostResolveScopedKycSettings"];
3575
+ };
3564
3576
  "/password-tokens": {
3565
3577
  /** Retrieves a list of reset password tokens. */
3566
3578
  get: operations["GetPasswordTokenCollection"];
@@ -10364,6 +10376,20 @@ export interface coreComponents {
10364
10376
  };
10365
10377
  /** Document verification level. */
10366
10378
  KycDocumentMatchLevels: 1 | 2 | 3;
10379
+ /**
10380
+ * Document subtypes that are prohibited for `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
10381
+ * This object does not include `credit-file-proof` because it has no subtypes.
10382
+ */
10383
+ KycSubtypeRestrictions: {
10384
+ /** Prohibited subtypes of proof of identity. */
10385
+ identityProof?: string[];
10386
+ /** Prohibited subtypes of proof of address. */
10387
+ addressProof?: string[];
10388
+ /** Prohibited subtypes of proof of funds. */
10389
+ fundsProof?: string[];
10390
+ /** Prohibited subtypes of proof of purchase. */
10391
+ purchaseProof?: string[];
10392
+ };
10367
10393
  /** KYC request information. */
10368
10394
  KycRequest: {
10369
10395
  /** ID of the KYC request. */
@@ -10406,6 +10432,10 @@ export interface coreComponents {
10406
10432
  * Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
10407
10433
  */
10408
10434
  revision?: number;
10435
+ /** Document subtypes that are prohibited for this KYC request. */
10436
+ subtypeRestrictions?: coreComponents["schemas"]["KycSubtypeRestrictions"];
10437
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
10438
+ subtypeRestrictionUiEnabled?: boolean;
10409
10439
  /**
10410
10440
  * Date and time when the request expires.
10411
10441
  * The default value is one hour in the future.
@@ -10433,6 +10463,7 @@ export interface coreComponents {
10433
10463
  | "document-not-matching"
10434
10464
  | "document-duplicate"
10435
10465
  | "document-invalid"
10466
+ | "document-subtype-prohibited"
10436
10467
  | "document-not-open"
10437
10468
  | "underage-person"
10438
10469
  | "third-party-or-mismatch"
@@ -11312,13 +11343,110 @@ export interface coreComponents {
11312
11343
  */
11313
11344
  type: "funds-proof";
11314
11345
  } & coreComponents["schemas"]["FundsMatches"];
11346
+ /** Conditions that determine when a document subtype is prohibited. */
11347
+ KycProhibitedSubtypeCondition: {
11348
+ /**
11349
+ * Specifies if the restriction depends on face proof being required for the KYC request.
11350
+ * Use `true` if face proof is required, or `false` if it is not required.
11351
+ */
11352
+ faceProofRequired: boolean;
11353
+ };
11354
+ /**
11355
+ * Restriction for a prohibited document subtype.
11356
+ * If this object is empty, the document subtype is always prohibited.
11357
+ * If `when` is not specified, the restriction applies unconditionally.
11358
+ */
11359
+ KycProhibitedSubtypeRule: {
11360
+ when?: coreComponents["schemas"]["KycProhibitedSubtypeCondition"];
11361
+ };
11362
+ /**
11363
+ * Map of prohibited document subtypes for a type of KYC document.
11364
+ * Each key must be a subtype of the specified document type.
11365
+ * Use an empty object to accept all document subtypes.
11366
+ */
11367
+ KycProhibitedSubtypes: {
11368
+ [key: string]: coreComponents["schemas"]["KycProhibitedSubtypeRule"];
11369
+ };
11370
+ /** Settings for a type of KYC document. */
11371
+ ScopedKycSettingsProofBlock: {
11372
+ prohibitedSubtypes?: coreComponents["schemas"]["KycProhibitedSubtypes"];
11373
+ };
11374
+ /**
11375
+ * Document subtype restrictions that override the organization-level restrictions for a group of websites.
11376
+ * Website IDs must identify websites associated with the organization.
11377
+ * Each website ID can appear in only one override.
11378
+ * Proof types are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
11379
+ * This object does not include `credit-file-proof` because it has no subtypes.
11380
+ * For each proof type, `prohibitedSubtypes` overrides the organization value.
11381
+ * If `prohibitedSubtypes` is omitted, the proof type inherits the organization value.
11382
+ * Use an empty `prohibitedSubtypes` object to accept all subtypes for the websites.
11383
+ */
11384
+ ScopedKycSettingsWebsiteOverride: {
11385
+ /** IDs of websites where the override applies. */
11386
+ websiteIds: coreComponents["schemas"]["WebsiteId"][];
11387
+ identityProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11388
+ addressProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11389
+ fundsProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11390
+ purchaseProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11391
+ };
11392
+ /**
11393
+ * Document subtype restrictions for an organization and the websites associated with it.
11394
+ * Proof type keys are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
11395
+ * This object does not include `credit-file-proof` because it has no subtypes.
11396
+ * Restrictions at the organization level apply by default.
11397
+ * A website overrides the organization restrictions for a proof type when `prohibitedSubtypes` is specified.
11398
+ */
11399
+ ScopedKycSettings: {
11400
+ identityProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11401
+ addressProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11402
+ fundsProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11403
+ purchaseProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11404
+ /**
11405
+ * Document subtype restrictions that override subtype restrictions for selected websites.
11406
+ * Each website ID can appear in only one override.
11407
+ */
11408
+ websiteOverrides?: coreComponents["schemas"]["ScopedKycSettingsWebsiteOverride"][];
11409
+ };
11315
11410
  /** Settings for KYC score calculation. */
11316
11411
  KycSettings: {
11317
11412
  identityProof?: coreComponents["schemas"]["KycSettingsIdentity"];
11318
11413
  addressProof?: coreComponents["schemas"]["KycSettingsAddress"];
11414
+ /**
11415
+ * Document subtype restrictions for the organization and its websites.
11416
+ * When updating KYC settings, this object replaces the existing scoped KYC settings.
11417
+ * If this field is omitted, the existing scoped KYC settings do not change.
11418
+ * Use `null` to remove all scoped KYC settings.
11419
+ */
11420
+ scopedKycSettings?: coreComponents["schemas"]["ScopedKycSettings"] | null;
11319
11421
  /** Version of the KYC document gatherer UI. */
11320
11422
  uiVersion?: ("1" | "2") | null;
11321
11423
  };
11424
+ /** KYC document settings that are used to evaluate document subtype restrictions. */
11425
+ ResolveScopedKycSettingsDocument: {
11426
+ /** Type of KYC document. */
11427
+ type: coreComponents["schemas"]["KycDocumentTypes"];
11428
+ /**
11429
+ * Document subtypes to evaluate for restrictions.
11430
+ * If omitted, all configured restrictions for the document type are evaluated.
11431
+ */
11432
+ subtypes?: string[];
11433
+ /** Specifies if the customer must provide proof of their face with the KYC document. */
11434
+ faceProofRequired?: boolean;
11435
+ };
11436
+ /** Information that is used to evaluate document subtype restrictions for a website. */
11437
+ ResolveScopedKycSettingsRequest: {
11438
+ websiteId: coreComponents["schemas"]["WebsiteId"];
11439
+ /**
11440
+ * KYC document settings to evaluate for subtype restrictions.
11441
+ * If omitted or empty, the response contains only unconditional restrictions for all configured document types.
11442
+ */
11443
+ documents?: coreComponents["schemas"]["ResolveScopedKycSettingsDocument"][];
11444
+ };
11445
+ /** Result of evaluating document subtype restrictions for a website. */
11446
+ ResolveScopedKycSettingsResponse: {
11447
+ /** Document subtype restrictions that match the request. */
11448
+ subtypeRestrictions: coreComponents["schemas"]["KycSubtypeRestrictions"];
11449
+ };
11322
11450
  ResetPasswordToken: {
11323
11451
  /** ID of the token. */
11324
11452
  token?: string;
@@ -26977,6 +27105,10 @@ export interface coreComponents {
26977
27105
  * Example: `https://example.com?info=success`.
26978
27106
  */
26979
27107
  redirectUrl?: string;
27108
+ /** Document subtypes that are prohibited for this KYC request. */
27109
+ subtypeRestrictions?: coreComponents["schemas"]["KycSubtypeRestrictions"];
27110
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
27111
+ subtypeRestrictionUiEnabled?: boolean;
26980
27112
  /**
26981
27113
  * Date and time when the request expires.
26982
27114
  * The default value is one hour in the future.
@@ -32731,6 +32863,8 @@ export interface operations {
32731
32863
  * order, prefix with `-`. Multiple fields can be sorted by separating each with `,`.
32732
32864
  */
32733
32865
  sort?: coreComponents["parameters"]["collectionSort"];
32866
+ /** Limits `_links` to these rels. An empty value omits `_links`. Omit the parameter to return every rel. */
32867
+ links?: string;
32734
32868
  };
32735
32869
  };
32736
32870
  responses: {
@@ -33998,6 +34132,8 @@ export interface operations {
33998
34132
  * [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
33999
34133
  */
34000
34134
  expand?: coreComponents["parameters"]["collectionExpand"];
34135
+ /** Limits `_links` to these rels. An empty value omits `_links`. Omit the parameter to return every rel. */
34136
+ links?: string;
34001
34137
  };
34002
34138
  };
34003
34139
  responses: {
@@ -35479,6 +35615,8 @@ export interface operations {
35479
35615
  * [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
35480
35616
  */
35481
35617
  expand?: coreComponents["parameters"]["collectionExpand"];
35618
+ /** Limits `_links` to these rels. An empty value omits `_links`. Omit the parameter to return every rel. */
35619
+ links?: string;
35482
35620
  };
35483
35621
  };
35484
35622
  responses: {
@@ -35778,6 +35916,7 @@ export interface operations {
35778
35916
  401: coreComponents["responses"]["Unauthorized"];
35779
35917
  403: coreComponents["responses"]["Forbidden"];
35780
35918
  404: coreComponents["responses"]["NotFound"];
35919
+ 422: coreComponents["responses"]["ValidationError"];
35781
35920
  429: coreComponents["responses"]["TooManyRequests"];
35782
35921
  };
35783
35922
  /** Settings for KYC analysis. */
@@ -35787,6 +35926,31 @@ export interface operations {
35787
35926
  };
35788
35927
  };
35789
35928
  };
35929
+ /**
35930
+ * Resolves document subtype restrictions for a website.
35931
+ * When `documents` are provided, the response contains restrictions that match the document types, subtypes, and face proof requirements.
35932
+ */
35933
+ PostResolveScopedKycSettings: {
35934
+ responses: {
35935
+ /** Scoped KYC settings resolved. */
35936
+ 200: {
35937
+ headers: {};
35938
+ content: {
35939
+ "application/json": coreComponents["schemas"]["ResolveScopedKycSettingsResponse"];
35940
+ };
35941
+ };
35942
+ 401: coreComponents["responses"]["Unauthorized"];
35943
+ 403: coreComponents["responses"]["Forbidden"];
35944
+ 404: coreComponents["responses"]["NotFound"];
35945
+ 422: coreComponents["responses"]["ValidationError"];
35946
+ 429: coreComponents["responses"]["TooManyRequests"];
35947
+ };
35948
+ requestBody: {
35949
+ content: {
35950
+ "application/json": coreComponents["schemas"]["ResolveScopedKycSettingsRequest"];
35951
+ };
35952
+ };
35953
+ };
35790
35954
  /** Retrieves a list of reset password tokens. */
35791
35955
  GetPasswordTokenCollection: {
35792
35956
  parameters: {
@@ -37043,6 +37207,8 @@ export interface operations {
37043
37207
  * For more information, see [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
37044
37208
  */
37045
37209
  expand?: coreComponents["parameters"]["orderExpand"];
37210
+ /** Limits `_links` to these rels. An empty value omits `_links`. Omit the parameter to return every rel. */
37211
+ links?: string;
37046
37212
  };
37047
37213
  };
37048
37214
  responses: {
@@ -37829,6 +37995,8 @@ export interface operations {
37829
37995
  * For more information, see [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
37830
37996
  */
37831
37997
  expand?: coreComponents["parameters"]["subscriptionExpand"];
37998
+ /** Limits `_links` to these rels. An empty value omits `_links`. Omit the parameter to return every rel. */
37999
+ links?: string;
37832
38000
  };
37833
38001
  };
37834
38002
  responses: {
@@ -50887,6 +51055,20 @@ export interface storefrontComponents {
50887
51055
  };
50888
51056
  /** Document verification level. */
50889
51057
  KycDocumentMatchLevels: 1 | 2 | 3;
51058
+ /**
51059
+ * Document subtypes that are prohibited for `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
51060
+ * This object does not include `credit-file-proof` because it has no subtypes.
51061
+ */
51062
+ KycSubtypeRestrictions: {
51063
+ /** Prohibited subtypes of proof of identity. */
51064
+ identityProof?: string[];
51065
+ /** Prohibited subtypes of proof of address. */
51066
+ addressProof?: string[];
51067
+ /** Prohibited subtypes of proof of funds. */
51068
+ fundsProof?: string[];
51069
+ /** Prohibited subtypes of proof of purchase. */
51070
+ purchaseProof?: string[];
51071
+ };
50890
51072
  /** KYC request information. */
50891
51073
  KycRequest: {
50892
51074
  /** ID of the KYC request. */
@@ -50929,6 +51111,10 @@ export interface storefrontComponents {
50929
51111
  * Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
50930
51112
  */
50931
51113
  revision?: number;
51114
+ /** Document subtypes that are prohibited for this KYC request. */
51115
+ subtypeRestrictions?: storefrontComponents["schemas"]["KycSubtypeRestrictions"];
51116
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
51117
+ subtypeRestrictionUiEnabled?: boolean;
50932
51118
  /**
50933
51119
  * Date and time when the request expires.
50934
51120
  * The default value is one hour in the future.
@@ -50956,6 +51142,7 @@ export interface storefrontComponents {
50956
51142
  | "document-not-matching"
50957
51143
  | "document-duplicate"
50958
51144
  | "document-invalid"
51145
+ | "document-subtype-prohibited"
50959
51146
  | "document-not-open"
50960
51147
  | "underage-person"
50961
51148
  | "third-party-or-mismatch"
@@ -51835,13 +52022,110 @@ export interface storefrontComponents {
51835
52022
  */
51836
52023
  type: "funds-proof";
51837
52024
  } & storefrontComponents["schemas"]["FundsMatches"];
52025
+ /** Conditions that determine when a document subtype is prohibited. */
52026
+ KycProhibitedSubtypeCondition: {
52027
+ /**
52028
+ * Specifies if the restriction depends on face proof being required for the KYC request.
52029
+ * Use `true` if face proof is required, or `false` if it is not required.
52030
+ */
52031
+ faceProofRequired: boolean;
52032
+ };
52033
+ /**
52034
+ * Restriction for a prohibited document subtype.
52035
+ * If this object is empty, the document subtype is always prohibited.
52036
+ * If `when` is not specified, the restriction applies unconditionally.
52037
+ */
52038
+ KycProhibitedSubtypeRule: {
52039
+ when?: storefrontComponents["schemas"]["KycProhibitedSubtypeCondition"];
52040
+ };
52041
+ /**
52042
+ * Map of prohibited document subtypes for a type of KYC document.
52043
+ * Each key must be a subtype of the specified document type.
52044
+ * Use an empty object to accept all document subtypes.
52045
+ */
52046
+ KycProhibitedSubtypes: {
52047
+ [key: string]: storefrontComponents["schemas"]["KycProhibitedSubtypeRule"];
52048
+ };
52049
+ /** Settings for a type of KYC document. */
52050
+ ScopedKycSettingsProofBlock: {
52051
+ prohibitedSubtypes?: storefrontComponents["schemas"]["KycProhibitedSubtypes"];
52052
+ };
52053
+ /**
52054
+ * Document subtype restrictions that override the organization-level restrictions for a group of websites.
52055
+ * Website IDs must identify websites associated with the organization.
52056
+ * Each website ID can appear in only one override.
52057
+ * Proof types are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
52058
+ * This object does not include `credit-file-proof` because it has no subtypes.
52059
+ * For each proof type, `prohibitedSubtypes` overrides the organization value.
52060
+ * If `prohibitedSubtypes` is omitted, the proof type inherits the organization value.
52061
+ * Use an empty `prohibitedSubtypes` object to accept all subtypes for the websites.
52062
+ */
52063
+ ScopedKycSettingsWebsiteOverride: {
52064
+ /** IDs of websites where the override applies. */
52065
+ websiteIds: storefrontComponents["schemas"]["WebsiteId"][];
52066
+ identityProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52067
+ addressProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52068
+ fundsProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52069
+ purchaseProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52070
+ };
52071
+ /**
52072
+ * Document subtype restrictions for an organization and the websites associated with it.
52073
+ * Proof type keys are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
52074
+ * This object does not include `credit-file-proof` because it has no subtypes.
52075
+ * Restrictions at the organization level apply by default.
52076
+ * A website overrides the organization restrictions for a proof type when `prohibitedSubtypes` is specified.
52077
+ */
52078
+ ScopedKycSettings: {
52079
+ identityProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52080
+ addressProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52081
+ fundsProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52082
+ purchaseProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52083
+ /**
52084
+ * Document subtype restrictions that override subtype restrictions for selected websites.
52085
+ * Each website ID can appear in only one override.
52086
+ */
52087
+ websiteOverrides?: storefrontComponents["schemas"]["ScopedKycSettingsWebsiteOverride"][];
52088
+ };
51838
52089
  /** Settings for KYC score calculation. */
51839
52090
  KycSettings: {
51840
52091
  identityProof?: storefrontComponents["schemas"]["KycSettingsIdentity"];
51841
52092
  addressProof?: storefrontComponents["schemas"]["KycSettingsAddress"];
52093
+ /**
52094
+ * Document subtype restrictions for the organization and its websites.
52095
+ * When updating KYC settings, this object replaces the existing scoped KYC settings.
52096
+ * If this field is omitted, the existing scoped KYC settings do not change.
52097
+ * Use `null` to remove all scoped KYC settings.
52098
+ */
52099
+ scopedKycSettings?: storefrontComponents["schemas"]["ScopedKycSettings"] | null;
51842
52100
  /** Version of the KYC document gatherer UI. */
51843
52101
  uiVersion?: ("1" | "2") | null;
51844
52102
  };
52103
+ /** KYC document settings that are used to evaluate document subtype restrictions. */
52104
+ ResolveScopedKycSettingsDocument: {
52105
+ /** Type of KYC document. */
52106
+ type: storefrontComponents["schemas"]["KycDocumentTypes"];
52107
+ /**
52108
+ * Document subtypes to evaluate for restrictions.
52109
+ * If omitted, all configured restrictions for the document type are evaluated.
52110
+ */
52111
+ subtypes?: string[];
52112
+ /** Specifies if the customer must provide proof of their face with the KYC document. */
52113
+ faceProofRequired?: boolean;
52114
+ };
52115
+ /** Information that is used to evaluate document subtype restrictions for a website. */
52116
+ ResolveScopedKycSettingsRequest: {
52117
+ websiteId: storefrontComponents["schemas"]["WebsiteId"];
52118
+ /**
52119
+ * KYC document settings to evaluate for subtype restrictions.
52120
+ * If omitted or empty, the response contains only unconditional restrictions for all configured document types.
52121
+ */
52122
+ documents?: storefrontComponents["schemas"]["ResolveScopedKycSettingsDocument"][];
52123
+ };
52124
+ /** Result of evaluating document subtype restrictions for a website. */
52125
+ ResolveScopedKycSettingsResponse: {
52126
+ /** Document subtype restrictions that match the request. */
52127
+ subtypeRestrictions: storefrontComponents["schemas"]["KycSubtypeRestrictions"];
52128
+ };
51845
52129
  ResetPasswordToken: {
51846
52130
  /** ID of the token. */
51847
52131
  token?: string;
@@ -67500,6 +67784,10 @@ export interface storefrontComponents {
67500
67784
  * Example: `https://example.com?info=success`.
67501
67785
  */
67502
67786
  redirectUrl?: string;
67787
+ /** Document subtypes that are prohibited for this KYC request. */
67788
+ subtypeRestrictions?: storefrontComponents["schemas"]["KycSubtypeRestrictions"];
67789
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
67790
+ subtypeRestrictionUiEnabled?: boolean;
67503
67791
  /**
67504
67792
  * Date and time when the request expires.
67505
67793
  * The default value is one hour in the future.
@@ -78622,6 +78910,20 @@ export interface reportsComponents {
78622
78910
  };
78623
78911
  /** Document verification level. */
78624
78912
  KycDocumentMatchLevels: 1 | 2 | 3;
78913
+ /**
78914
+ * Document subtypes that are prohibited for `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
78915
+ * This object does not include `credit-file-proof` because it has no subtypes.
78916
+ */
78917
+ KycSubtypeRestrictions: {
78918
+ /** Prohibited subtypes of proof of identity. */
78919
+ identityProof?: string[];
78920
+ /** Prohibited subtypes of proof of address. */
78921
+ addressProof?: string[];
78922
+ /** Prohibited subtypes of proof of funds. */
78923
+ fundsProof?: string[];
78924
+ /** Prohibited subtypes of proof of purchase. */
78925
+ purchaseProof?: string[];
78926
+ };
78625
78927
  /** KYC request information. */
78626
78928
  KycRequest: {
78627
78929
  /** ID of the KYC request. */
@@ -78664,6 +78966,10 @@ export interface reportsComponents {
78664
78966
  * Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
78665
78967
  */
78666
78968
  revision?: number;
78969
+ /** Document subtypes that are prohibited for this KYC request. */
78970
+ subtypeRestrictions?: reportsComponents["schemas"]["KycSubtypeRestrictions"];
78971
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
78972
+ subtypeRestrictionUiEnabled?: boolean;
78667
78973
  /**
78668
78974
  * Date and time when the request expires.
78669
78975
  * The default value is one hour in the future.
@@ -78691,6 +78997,7 @@ export interface reportsComponents {
78691
78997
  | "document-not-matching"
78692
78998
  | "document-duplicate"
78693
78999
  | "document-invalid"
79000
+ | "document-subtype-prohibited"
78694
79001
  | "document-not-open"
78695
79002
  | "underage-person"
78696
79003
  | "third-party-or-mismatch"
@@ -79570,13 +79877,110 @@ export interface reportsComponents {
79570
79877
  */
79571
79878
  type: "funds-proof";
79572
79879
  } & reportsComponents["schemas"]["FundsMatches"];
79880
+ /** Conditions that determine when a document subtype is prohibited. */
79881
+ KycProhibitedSubtypeCondition: {
79882
+ /**
79883
+ * Specifies if the restriction depends on face proof being required for the KYC request.
79884
+ * Use `true` if face proof is required, or `false` if it is not required.
79885
+ */
79886
+ faceProofRequired: boolean;
79887
+ };
79888
+ /**
79889
+ * Restriction for a prohibited document subtype.
79890
+ * If this object is empty, the document subtype is always prohibited.
79891
+ * If `when` is not specified, the restriction applies unconditionally.
79892
+ */
79893
+ KycProhibitedSubtypeRule: {
79894
+ when?: reportsComponents["schemas"]["KycProhibitedSubtypeCondition"];
79895
+ };
79896
+ /**
79897
+ * Map of prohibited document subtypes for a type of KYC document.
79898
+ * Each key must be a subtype of the specified document type.
79899
+ * Use an empty object to accept all document subtypes.
79900
+ */
79901
+ KycProhibitedSubtypes: {
79902
+ [key: string]: reportsComponents["schemas"]["KycProhibitedSubtypeRule"];
79903
+ };
79904
+ /** Settings for a type of KYC document. */
79905
+ ScopedKycSettingsProofBlock: {
79906
+ prohibitedSubtypes?: reportsComponents["schemas"]["KycProhibitedSubtypes"];
79907
+ };
79908
+ /**
79909
+ * Document subtype restrictions that override the organization-level restrictions for a group of websites.
79910
+ * Website IDs must identify websites associated with the organization.
79911
+ * Each website ID can appear in only one override.
79912
+ * Proof types are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
79913
+ * This object does not include `credit-file-proof` because it has no subtypes.
79914
+ * For each proof type, `prohibitedSubtypes` overrides the organization value.
79915
+ * If `prohibitedSubtypes` is omitted, the proof type inherits the organization value.
79916
+ * Use an empty `prohibitedSubtypes` object to accept all subtypes for the websites.
79917
+ */
79918
+ ScopedKycSettingsWebsiteOverride: {
79919
+ /** IDs of websites where the override applies. */
79920
+ websiteIds: reportsComponents["schemas"]["WebsiteId"][];
79921
+ identityProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79922
+ addressProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79923
+ fundsProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79924
+ purchaseProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79925
+ };
79926
+ /**
79927
+ * Document subtype restrictions for an organization and the websites associated with it.
79928
+ * Proof type keys are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
79929
+ * This object does not include `credit-file-proof` because it has no subtypes.
79930
+ * Restrictions at the organization level apply by default.
79931
+ * A website overrides the organization restrictions for a proof type when `prohibitedSubtypes` is specified.
79932
+ */
79933
+ ScopedKycSettings: {
79934
+ identityProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79935
+ addressProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79936
+ fundsProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79937
+ purchaseProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79938
+ /**
79939
+ * Document subtype restrictions that override subtype restrictions for selected websites.
79940
+ * Each website ID can appear in only one override.
79941
+ */
79942
+ websiteOverrides?: reportsComponents["schemas"]["ScopedKycSettingsWebsiteOverride"][];
79943
+ };
79573
79944
  /** Settings for KYC score calculation. */
79574
79945
  KycSettings: {
79575
79946
  identityProof?: reportsComponents["schemas"]["KycSettingsIdentity"];
79576
79947
  addressProof?: reportsComponents["schemas"]["KycSettingsAddress"];
79948
+ /**
79949
+ * Document subtype restrictions for the organization and its websites.
79950
+ * When updating KYC settings, this object replaces the existing scoped KYC settings.
79951
+ * If this field is omitted, the existing scoped KYC settings do not change.
79952
+ * Use `null` to remove all scoped KYC settings.
79953
+ */
79954
+ scopedKycSettings?: reportsComponents["schemas"]["ScopedKycSettings"] | null;
79577
79955
  /** Version of the KYC document gatherer UI. */
79578
79956
  uiVersion?: ("1" | "2") | null;
79579
79957
  };
79958
+ /** KYC document settings that are used to evaluate document subtype restrictions. */
79959
+ ResolveScopedKycSettingsDocument: {
79960
+ /** Type of KYC document. */
79961
+ type: reportsComponents["schemas"]["KycDocumentTypes"];
79962
+ /**
79963
+ * Document subtypes to evaluate for restrictions.
79964
+ * If omitted, all configured restrictions for the document type are evaluated.
79965
+ */
79966
+ subtypes?: string[];
79967
+ /** Specifies if the customer must provide proof of their face with the KYC document. */
79968
+ faceProofRequired?: boolean;
79969
+ };
79970
+ /** Information that is used to evaluate document subtype restrictions for a website. */
79971
+ ResolveScopedKycSettingsRequest: {
79972
+ websiteId: reportsComponents["schemas"]["WebsiteId"];
79973
+ /**
79974
+ * KYC document settings to evaluate for subtype restrictions.
79975
+ * If omitted or empty, the response contains only unconditional restrictions for all configured document types.
79976
+ */
79977
+ documents?: reportsComponents["schemas"]["ResolveScopedKycSettingsDocument"][];
79978
+ };
79979
+ /** Result of evaluating document subtype restrictions for a website. */
79980
+ ResolveScopedKycSettingsResponse: {
79981
+ /** Document subtype restrictions that match the request. */
79982
+ subtypeRestrictions: reportsComponents["schemas"]["KycSubtypeRestrictions"];
79983
+ };
79580
79984
  ResetPasswordToken: {
79581
79985
  /** ID of the token. */
79582
79986
  token?: string;
@@ -95235,6 +95639,10 @@ export interface reportsComponents {
95235
95639
  * Example: `https://example.com?info=success`.
95236
95640
  */
95237
95641
  redirectUrl?: string;
95642
+ /** Document subtypes that are prohibited for this KYC request. */
95643
+ subtypeRestrictions?: reportsComponents["schemas"]["KycSubtypeRestrictions"];
95644
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
95645
+ subtypeRestrictionUiEnabled?: boolean;
95238
95646
  /**
95239
95647
  * Date and time when the request expires.
95240
95648
  * The default value is one hour in the future.
@@ -102128,6 +102536,10 @@ declare module "rebilly-js-sdk" {
102128
102536
  export type PutKycSettingsRequest = rebilly.PutKycSettingsRequest;
102129
102537
  export type PutKycSettingsResponse = rebilly.PutKycSettingsResponse;
102130
102538
  export type PutKycSettingsResponsePromise = rebilly.PutKycSettingsResponsePromise;
102539
+ export type PostResolveScopedKycSettingsRequest = rebilly.PostResolveScopedKycSettingsRequest;
102540
+ export type CreateResolveScopedKycSettingsRequest = rebilly.CreateResolveScopedKycSettingsRequest;
102541
+ export type PostResolveScopedKycSettingsResponse = rebilly.PostResolveScopedKycSettingsResponse;
102542
+ export type PostResolveScopedKycSettingsResponsePromise = rebilly.PostResolveScopedKycSettingsResponsePromise;
102131
102543
  export type GetPasswordTokenCollectionRequest = rebilly.GetPasswordTokenCollectionRequest;
102132
102544
  export type GetPasswordTokenCollectionResponse = rebilly.GetPasswordTokenCollectionResponse;
102133
102545
  export type GetPasswordTokenCollectionResponsePromise = rebilly.GetPasswordTokenCollectionResponsePromise;
@@ -104111,7 +104523,7 @@ declare module "resources/customers-resource" {
104111
104523
  export default function CustomersResource({ apiHandler }: {
104112
104524
  apiHandler: any;
104113
104525
  }): {
104114
- getAll({ limit, offset, filter, q, expand, fields, sort, }?: rebilly.GetCustomerCollectionRequest): rebilly.GetCustomerCollectionResponsePromise;
104526
+ getAll({ limit, offset, filter, q, expand, fields, sort, links, }?: rebilly.GetCustomerCollectionRequest): rebilly.GetCustomerCollectionResponsePromise;
104115
104527
  create({ id, data, expand }: rebilly.CreateCustomerRequest): rebilly.PostCustomerResponsePromise;
104116
104528
  get({ id, expand, fields }: {
104117
104529
  id: any;
@@ -104585,7 +104997,7 @@ declare module "resources/invoices-resource" {
104585
104997
  export default function InvoicesResource({ apiHandler }: {
104586
104998
  apiHandler: any;
104587
104999
  }): {
104588
- getAll({ filter, sort, limit, offset, q, expand, }?: rebilly.GetInvoiceCollectionRequest): rebilly.GetInvoiceCollectionResponsePromise;
105000
+ getAll({ filter, sort, limit, offset, q, expand, links, }?: rebilly.GetInvoiceCollectionRequest): rebilly.GetInvoiceCollectionResponsePromise;
104589
105001
  create({ id, data }: rebilly.CreateInvoiceRequest): rebilly.PostInvoiceResponsePromise;
104590
105002
  get({ id, expand }: {
104591
105003
  id: any;
@@ -104709,7 +105121,7 @@ declare module "resources/kyc-documents-resource" {
104709
105121
  export default function KycDocumentsResource({ apiHandler }: {
104710
105122
  apiHandler: any;
104711
105123
  }): {
104712
- getAll({ limit, offset, filter, sort, expand, }?: rebilly.GetKycDocumentCollectionRequest): rebilly.GetKycDocumentCollectionResponsePromise;
105124
+ getAll({ limit, offset, filter, sort, expand, links, }?: rebilly.GetKycDocumentCollectionRequest): rebilly.GetKycDocumentCollectionResponsePromise;
104713
105125
  create({ id, data }: rebilly.CreateKycDocumentRequest): rebilly.PostKycDocumentResponsePromise;
104714
105126
  get({ id }: {
104715
105127
  id: any;
@@ -104768,6 +105180,9 @@ declare module "resources/kyc-settings-resource" {
104768
105180
  updateKycSettings({ data }: {
104769
105181
  data: any;
104770
105182
  }): rebilly.PutKycSettingsResponsePromise;
105183
+ resolveScopedSettings({ data }: {
105184
+ data: any;
105185
+ }): any;
104771
105186
  };
104772
105187
  }
104773
105188
  declare module "resources/lists-resource" {
@@ -104867,7 +105282,7 @@ declare module "resources/orders-resource" {
104867
105282
  export default function OrdersResource({ apiHandler }: {
104868
105283
  apiHandler: any;
104869
105284
  }): {
104870
- getAll({ filter, sort, limit, offset, q, expand, }?: rebilly.GetOrderCollectionRequest): rebilly.GetOrderCollectionResponsePromise;
105285
+ getAll({ filter, sort, limit, offset, q, expand, links, }?: rebilly.GetOrderCollectionRequest): rebilly.GetOrderCollectionResponsePromise;
104871
105286
  create({ id, data, expand }: rebilly.CreateOrderRequest): rebilly.PostOrderResponsePromise;
104872
105287
  get({ id, expand }: {
104873
105288
  id: any;
@@ -105468,7 +105883,7 @@ declare module "resources/subscriptions-resource" {
105468
105883
  export default function SubscriptionsResource({ apiHandler }: {
105469
105884
  apiHandler: any;
105470
105885
  }): {
105471
- getAll({ filter, sort, limit, offset, q, expand, }?: rebilly.GetSubscriptionCollectionRequest): rebilly.GetSubscriptionCollectionResponsePromise;
105886
+ getAll({ filter, sort, limit, offset, q, expand, links, }?: rebilly.GetSubscriptionCollectionRequest): rebilly.GetSubscriptionCollectionResponsePromise;
105472
105887
  create({ id, data, expand }: rebilly.CreateSubscriptionRequest): rebilly.PostSubscriptionResponsePromise;
105473
105888
  get({ id, expand }: {
105474
105889
  id: any;
@@ -106058,7 +106473,7 @@ declare module "resources/api-instance" {
106058
106473
  }): any;
106059
106474
  };
106060
106475
  customers: {
106061
- getAll({ limit, offset, filter, q, expand, fields, sort, }?: rebilly.GetCustomerCollectionRequest): rebilly.GetCustomerCollectionResponsePromise;
106476
+ getAll({ limit, offset, filter, q, expand, fields, sort, links, }?: rebilly.GetCustomerCollectionRequest): rebilly.GetCustomerCollectionResponsePromise;
106062
106477
  create({ id, data, expand }: rebilly.CreateCustomerRequest): rebilly.PostCustomerResponsePromise;
106063
106478
  get({ id, expand, fields }: {
106064
106479
  id: any;
@@ -106472,7 +106887,7 @@ declare module "resources/api-instance" {
106472
106887
  }): rebilly.GetIntegrationResponsePromise;
106473
106888
  };
106474
106889
  invoices: {
106475
- getAll({ filter, sort, limit, offset, q, expand, }?: rebilly.GetInvoiceCollectionRequest): rebilly.GetInvoiceCollectionResponsePromise;
106890
+ getAll({ filter, sort, limit, offset, q, expand, links, }?: rebilly.GetInvoiceCollectionRequest): rebilly.GetInvoiceCollectionResponsePromise;
106476
106891
  create({ id, data }: rebilly.CreateInvoiceRequest): rebilly.PostInvoiceResponsePromise;
106477
106892
  get({ id, expand }: {
106478
106893
  id: any;
@@ -106580,7 +106995,7 @@ declare module "resources/api-instance" {
106580
106995
  }): any;
106581
106996
  };
106582
106997
  kycDocuments: {
106583
- getAll({ limit, offset, filter, sort, expand, }?: rebilly.GetKycDocumentCollectionRequest): rebilly.GetKycDocumentCollectionResponsePromise;
106998
+ getAll({ limit, offset, filter, sort, expand, links, }?: rebilly.GetKycDocumentCollectionRequest): rebilly.GetKycDocumentCollectionResponsePromise;
106584
106999
  create({ id, data }: rebilly.CreateKycDocumentRequest): rebilly.PostKycDocumentResponsePromise;
106585
107000
  get({ id }: {
106586
107001
  id: any;
@@ -106631,6 +107046,9 @@ declare module "resources/api-instance" {
106631
107046
  updateKycSettings({ data }: {
106632
107047
  data: any;
106633
107048
  }): rebilly.PutKycSettingsResponsePromise;
107049
+ resolveScopedSettings({ data }: {
107050
+ data: any;
107051
+ }): any;
106634
107052
  };
106635
107053
  lists: {
106636
107054
  getAll({ limit, offset, filter, sort, fields, q, }?: rebilly.GetListCollectionRequest): rebilly.GetListCollectionResponsePromise;
@@ -106706,7 +107124,7 @@ declare module "resources/api-instance" {
106706
107124
  }): rebilly.GetOrderReactivationResponsePromise;
106707
107125
  };
106708
107126
  orders: {
106709
- getAll({ filter, sort, limit, offset, q, expand, }?: rebilly.GetOrderCollectionRequest): rebilly.GetOrderCollectionResponsePromise;
107127
+ getAll({ filter, sort, limit, offset, q, expand, links, }?: rebilly.GetOrderCollectionRequest): rebilly.GetOrderCollectionResponsePromise;
106710
107128
  create({ id, data, expand }: rebilly.CreateOrderRequest): rebilly.PostOrderResponsePromise;
106711
107129
  get({ id, expand }: {
106712
107130
  id: any;
@@ -107163,7 +107581,7 @@ declare module "resources/api-instance" {
107163
107581
  }): rebilly.GetSubscriptionReactivationResponsePromise;
107164
107582
  };
107165
107583
  subscriptions: {
107166
- getAll({ filter, sort, limit, offset, q, expand, }?: rebilly.GetSubscriptionCollectionRequest): rebilly.GetSubscriptionCollectionResponsePromise;
107584
+ getAll({ filter, sort, limit, offset, q, expand, links, }?: rebilly.GetSubscriptionCollectionRequest): rebilly.GetSubscriptionCollectionResponsePromise;
107167
107585
  create({ id, data, expand }: rebilly.CreateSubscriptionRequest): rebilly.PostSubscriptionResponsePromise;
107168
107586
  get({ id, expand }: {
107169
107587
  id: any;