@onfido/api 5.0.0 → 5.2.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.
package/dist/api.d.ts CHANGED
@@ -410,6 +410,31 @@ export interface ApplicantBuilder {
410
410
  */
411
411
  'last_name': string;
412
412
  }
413
+ /**
414
+ *
415
+ * @export
416
+ * @interface ApplicantConsent
417
+ */
418
+ export interface ApplicantConsent {
419
+ /**
420
+ *
421
+ * @type {ApplicantConsentName}
422
+ * @memberof ApplicantConsent
423
+ */
424
+ 'name': ApplicantConsentName;
425
+ /**
426
+ *
427
+ * @type {boolean}
428
+ * @memberof ApplicantConsent
429
+ */
430
+ 'granted': boolean;
431
+ /**
432
+ * The date and time when this applicant consent was granted, if not granted the value is nil.
433
+ * @type {string}
434
+ * @memberof ApplicantConsent
435
+ */
436
+ 'granted_at': string | null;
437
+ }
413
438
  /**
414
439
  *
415
440
  * @export
@@ -869,6 +894,13 @@ export interface CheckBuilder {
869
894
  * @memberof CheckBuilder
870
895
  */
871
896
  'us_driving_licence'?: UsDrivingLicenceBuilder;
897
+ /**
898
+ *
899
+ * @type {ReportConfiguration}
900
+ * @memberof CheckBuilder
901
+ * @deprecated
902
+ */
903
+ 'report_configuration'?: ReportConfiguration;
872
904
  }
873
905
  /**
874
906
  *
@@ -924,6 +956,13 @@ export interface CheckRequest {
924
956
  * @memberof CheckRequest
925
957
  */
926
958
  'us_driving_licence'?: UsDrivingLicenceBuilder;
959
+ /**
960
+ *
961
+ * @type {ReportConfiguration}
962
+ * @memberof CheckRequest
963
+ * @deprecated
964
+ */
965
+ 'report_configuration'?: ReportConfiguration;
927
966
  }
928
967
  /**
929
968
  *
@@ -1359,16 +1398,24 @@ export type CountryCodes = typeof CountryCodes[keyof typeof CountryCodes];
1359
1398
  * @interface DeviceIntelligenceBreakdown
1360
1399
  */
1361
1400
  export interface DeviceIntelligenceBreakdown {
1401
+ /**
1402
+ *
1403
+ * @type {DeviceIntelligenceBreakdownDevice}
1404
+ * @memberof DeviceIntelligenceBreakdown
1405
+ */
1406
+ 'device'?: DeviceIntelligenceBreakdownDevice;
1362
1407
  /**
1363
1408
  *
1364
1409
  * @type {DeviceIntelligenceBreakdownBreakdown}
1365
1410
  * @memberof DeviceIntelligenceBreakdown
1411
+ * @deprecated
1366
1412
  */
1367
1413
  'breakdown'?: DeviceIntelligenceBreakdownBreakdown;
1368
1414
  /**
1369
1415
  *
1370
1416
  * @type {DeviceIntelligenceBreakdownProperties}
1371
1417
  * @memberof DeviceIntelligenceBreakdown
1418
+ * @deprecated
1372
1419
  */
1373
1420
  'properties'?: DeviceIntelligenceBreakdownProperties;
1374
1421
  }
@@ -1380,46 +1427,46 @@ export interface DeviceIntelligenceBreakdown {
1380
1427
  export interface DeviceIntelligenceBreakdownBreakdown {
1381
1428
  /**
1382
1429
  *
1383
- * @type {DeviceIntelligenceBreakdownBreakdownDevice}
1430
+ * @type {DeviceIntelligenceBreakdownDevice}
1384
1431
  * @memberof DeviceIntelligenceBreakdownBreakdown
1385
1432
  */
1386
- 'device'?: DeviceIntelligenceBreakdownBreakdownDevice;
1433
+ 'device'?: DeviceIntelligenceBreakdownDevice;
1387
1434
  }
1388
1435
  /**
1389
1436
  * Asserts whether the device used to upload the media is trustworthy, i.e. it is a real, physical device.
1390
1437
  * @export
1391
- * @interface DeviceIntelligenceBreakdownBreakdownDevice
1438
+ * @interface DeviceIntelligenceBreakdownDevice
1392
1439
  */
1393
- export interface DeviceIntelligenceBreakdownBreakdownDevice {
1440
+ export interface DeviceIntelligenceBreakdownDevice {
1394
1441
  /**
1395
1442
  *
1396
- * @type {DeviceIntelligenceBreakdownBreakdownDeviceBreakdown}
1397
- * @memberof DeviceIntelligenceBreakdownBreakdownDevice
1443
+ * @type {DeviceIntelligenceBreakdownDeviceBreakdown}
1444
+ * @memberof DeviceIntelligenceBreakdownDevice
1398
1445
  */
1399
- 'breakdown'?: DeviceIntelligenceBreakdownBreakdownDeviceBreakdown;
1446
+ 'breakdown'?: DeviceIntelligenceBreakdownDeviceBreakdown;
1400
1447
  }
1401
1448
  /**
1402
1449
  *
1403
1450
  * @export
1404
- * @interface DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1451
+ * @interface DeviceIntelligenceBreakdownDeviceBreakdown
1405
1452
  */
1406
- export interface DeviceIntelligenceBreakdownBreakdownDeviceBreakdown {
1453
+ export interface DeviceIntelligenceBreakdownDeviceBreakdown {
1407
1454
  /**
1408
1455
  *
1409
1456
  * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
1410
- * @memberof DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1457
+ * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
1411
1458
  */
1412
1459
  'application_authenticity'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
1413
1460
  /**
1414
1461
  *
1415
1462
  * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
1416
- * @memberof DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1463
+ * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
1417
1464
  */
1418
1465
  'device_integrity'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
1419
1466
  /**
1420
1467
  *
1421
1468
  * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
1422
- * @memberof DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1469
+ * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
1423
1470
  */
1424
1471
  'device_reputation'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
1425
1472
  }
@@ -1610,6 +1657,31 @@ export interface DeviceIntelligenceBreakdownPropertiesIp {
1610
1657
  */
1611
1658
  'address'?: string;
1612
1659
  }
1660
+ /**
1661
+ *
1662
+ * @export
1663
+ * @interface DeviceIntelligenceProperties
1664
+ */
1665
+ export interface DeviceIntelligenceProperties {
1666
+ /**
1667
+ *
1668
+ * @type {DeviceIntelligenceBreakdownPropertiesDevice}
1669
+ * @memberof DeviceIntelligenceProperties
1670
+ */
1671
+ 'device'?: DeviceIntelligenceBreakdownPropertiesDevice;
1672
+ /**
1673
+ *
1674
+ * @type {DeviceIntelligenceBreakdownPropertiesIp}
1675
+ * @memberof DeviceIntelligenceProperties
1676
+ */
1677
+ 'ip'?: DeviceIntelligenceBreakdownPropertiesIp;
1678
+ /**
1679
+ *
1680
+ * @type {DeviceIntelligenceBreakdownPropertiesGeolocation}
1681
+ * @memberof DeviceIntelligenceProperties
1682
+ */
1683
+ 'geolocation'?: DeviceIntelligenceBreakdownPropertiesGeolocation;
1684
+ }
1613
1685
  /**
1614
1686
  *
1615
1687
  * @export
@@ -1670,6 +1742,12 @@ export interface DeviceIntelligenceReport {
1670
1742
  * @memberof DeviceIntelligenceReport
1671
1743
  */
1672
1744
  'breakdown'?: DeviceIntelligenceBreakdown;
1745
+ /**
1746
+ *
1747
+ * @type {DeviceIntelligenceProperties}
1748
+ * @memberof DeviceIntelligenceReport
1749
+ */
1750
+ 'properties'?: DeviceIntelligenceProperties;
1673
1751
  }
1674
1752
  /**
1675
1753
  *
@@ -3020,10 +3098,10 @@ export interface DocumentProperties {
3020
3098
  'nfc'?: DocumentPropertiesNfc;
3021
3099
  /**
3022
3100
  *
3023
- * @type {DocumentPropertiesDrivingLicenceInformation}
3101
+ * @type {Array<DocumentPropertiesDrivingLicenceInformationItem>}
3024
3102
  * @memberof DocumentProperties
3025
3103
  */
3026
- 'driving_licence_information'?: DocumentPropertiesDrivingLicenceInformation;
3104
+ 'driving_licence_information'?: Array<DocumentPropertiesDrivingLicenceInformationItem>;
3027
3105
  /**
3028
3106
  *
3029
3107
  * @type {DocumentPropertiesDocumentClassification}
@@ -3269,31 +3347,31 @@ export interface DocumentPropertiesDocumentNumbersInner {
3269
3347
  /**
3270
3348
  *
3271
3349
  * @export
3272
- * @interface DocumentPropertiesDrivingLicenceInformation
3350
+ * @interface DocumentPropertiesDrivingLicenceInformationItem
3273
3351
  */
3274
- export interface DocumentPropertiesDrivingLicenceInformation {
3352
+ export interface DocumentPropertiesDrivingLicenceInformationItem {
3275
3353
  /**
3276
3354
  *
3277
3355
  * @type {string}
3278
- * @memberof DocumentPropertiesDrivingLicenceInformation
3356
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3279
3357
  */
3280
3358
  'category'?: string;
3281
3359
  /**
3282
3360
  *
3283
3361
  * @type {string}
3284
- * @memberof DocumentPropertiesDrivingLicenceInformation
3362
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3285
3363
  */
3286
3364
  'obtainment_date'?: string;
3287
3365
  /**
3288
3366
  *
3289
3367
  * @type {string}
3290
- * @memberof DocumentPropertiesDrivingLicenceInformation
3368
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3291
3369
  */
3292
3370
  'expiry_date'?: string;
3293
3371
  /**
3294
3372
  *
3295
3373
  * @type {string}
3296
- * @memberof DocumentPropertiesDrivingLicenceInformation
3374
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3297
3375
  */
3298
3376
  'codes'?: string;
3299
3377
  }
@@ -4324,10 +4402,10 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4324
4402
  'nfc'?: DocumentPropertiesNfc;
4325
4403
  /**
4326
4404
  *
4327
- * @type {DocumentPropertiesDrivingLicenceInformation}
4405
+ * @type {Array<DocumentPropertiesDrivingLicenceInformationItem>}
4328
4406
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4329
4407
  */
4330
- 'driving_licence_information'?: DocumentPropertiesDrivingLicenceInformation;
4408
+ 'driving_licence_information'?: Array<DocumentPropertiesDrivingLicenceInformationItem>;
4331
4409
  /**
4332
4410
  *
4333
4411
  * @type {DocumentPropertiesDocumentClassification}
@@ -7728,6 +7806,56 @@ export type Report = {
7728
7806
  } & WatchlistSanctionsOnlyReport | {
7729
7807
  name: 'watchlist_standard';
7730
7808
  } & WatchlistStandardReport;
7809
+ /**
7810
+ * Defines configuration options for facial similarity checks used to distinguish between onboarding and reverification scenarios.
7811
+ * @export
7812
+ * @interface ReportConfiguration
7813
+ */
7814
+ export interface ReportConfiguration {
7815
+ /**
7816
+ *
7817
+ * @type {ReportConfigurationFacialSimilarity}
7818
+ * @memberof ReportConfiguration
7819
+ */
7820
+ 'facial_similarity_photo'?: ReportConfigurationFacialSimilarity;
7821
+ /**
7822
+ *
7823
+ * @type {ReportConfigurationFacialSimilarity}
7824
+ * @memberof ReportConfiguration
7825
+ */
7826
+ 'facial_similarity_photo_fully_auto'?: ReportConfigurationFacialSimilarity;
7827
+ /**
7828
+ *
7829
+ * @type {ReportConfigurationFacialSimilarity}
7830
+ * @memberof ReportConfiguration
7831
+ */
7832
+ 'facial_similarity_video'?: ReportConfigurationFacialSimilarity;
7833
+ /**
7834
+ *
7835
+ * @type {ReportConfigurationFacialSimilarity}
7836
+ * @memberof ReportConfiguration
7837
+ */
7838
+ 'facial_similarity_motion'?: ReportConfigurationFacialSimilarity;
7839
+ }
7840
+ /**
7841
+ *
7842
+ * @export
7843
+ * @interface ReportConfigurationFacialSimilarity
7844
+ */
7845
+ export interface ReportConfigurationFacialSimilarity {
7846
+ /**
7847
+ * You should set it to \"reverification\" on a post-onboarding scenario (e.g. ongoing authentication).
7848
+ * @type {string}
7849
+ * @memberof ReportConfigurationFacialSimilarity
7850
+ */
7851
+ 'use_case'?: ReportConfigurationFacialSimilarityUseCaseEnum;
7852
+ }
7853
+ export declare const ReportConfigurationFacialSimilarityUseCaseEnum: {
7854
+ readonly Onboarding: "onboarding";
7855
+ readonly Reverification: "reverification";
7856
+ readonly UnknownDefaultOpenApi: "11184809";
7857
+ };
7858
+ export type ReportConfigurationFacialSimilarityUseCaseEnum = typeof ReportConfigurationFacialSimilarityUseCaseEnum[keyof typeof ReportConfigurationFacialSimilarityUseCaseEnum];
7731
7859
  /**
7732
7860
  *
7733
7861
  * @export
@@ -9764,6 +9892,36 @@ export interface Webhook {
9764
9892
  * @memberof Webhook
9765
9893
  */
9766
9894
  'payload_version'?: number;
9895
+ /**
9896
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
9897
+ * @type {boolean}
9898
+ * @memberof Webhook
9899
+ */
9900
+ 'oauth_enabled'?: boolean;
9901
+ /**
9902
+ * The url to fetch the OAuth access token using client credentials grant.
9903
+ * @type {string}
9904
+ * @memberof Webhook
9905
+ */
9906
+ 'oauth_server_url'?: string;
9907
+ /**
9908
+ * The client id to authenticate the client credentials grant.
9909
+ * @type {string}
9910
+ * @memberof Webhook
9911
+ */
9912
+ 'oauth_server_client_id'?: string;
9913
+ /**
9914
+ * The client secret to authenticate the client credentials grant.
9915
+ * @type {string}
9916
+ * @memberof Webhook
9917
+ */
9918
+ 'oauth_server_client_secret'?: string;
9919
+ /**
9920
+ * The scopes to be sent when requesting the access token.
9921
+ * @type {string}
9922
+ * @memberof Webhook
9923
+ */
9924
+ 'oauth_server_scope'?: string;
9767
9925
  /**
9768
9926
  * The unique identifier of the webhook.
9769
9927
  * @type {string}
@@ -9819,6 +9977,36 @@ export interface WebhookBuilder {
9819
9977
  * @memberof WebhookBuilder
9820
9978
  */
9821
9979
  'payload_version'?: number;
9980
+ /**
9981
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
9982
+ * @type {boolean}
9983
+ * @memberof WebhookBuilder
9984
+ */
9985
+ 'oauth_enabled'?: boolean;
9986
+ /**
9987
+ * The url to fetch the OAuth access token using client credentials grant.
9988
+ * @type {string}
9989
+ * @memberof WebhookBuilder
9990
+ */
9991
+ 'oauth_server_url'?: string;
9992
+ /**
9993
+ * The client id to authenticate the client credentials grant.
9994
+ * @type {string}
9995
+ * @memberof WebhookBuilder
9996
+ */
9997
+ 'oauth_server_client_id'?: string;
9998
+ /**
9999
+ * The client secret to authenticate the client credentials grant.
10000
+ * @type {string}
10001
+ * @memberof WebhookBuilder
10002
+ */
10003
+ 'oauth_server_client_secret'?: string;
10004
+ /**
10005
+ * The scopes to be sent when requesting the access token.
10006
+ * @type {string}
10007
+ * @memberof WebhookBuilder
10008
+ */
10009
+ 'oauth_server_scope'?: string;
9822
10010
  /**
9823
10011
  * The url that will listen to notifications (must be https).
9824
10012
  * @type {string}
@@ -10168,6 +10356,36 @@ export interface WebhookShared {
10168
10356
  * @memberof WebhookShared
10169
10357
  */
10170
10358
  'payload_version'?: number;
10359
+ /**
10360
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
10361
+ * @type {boolean}
10362
+ * @memberof WebhookShared
10363
+ */
10364
+ 'oauth_enabled'?: boolean;
10365
+ /**
10366
+ * The url to fetch the OAuth access token using client credentials grant.
10367
+ * @type {string}
10368
+ * @memberof WebhookShared
10369
+ */
10370
+ 'oauth_server_url'?: string;
10371
+ /**
10372
+ * The client id to authenticate the client credentials grant.
10373
+ * @type {string}
10374
+ * @memberof WebhookShared
10375
+ */
10376
+ 'oauth_server_client_id'?: string;
10377
+ /**
10378
+ * The client secret to authenticate the client credentials grant.
10379
+ * @type {string}
10380
+ * @memberof WebhookShared
10381
+ */
10382
+ 'oauth_server_client_secret'?: string;
10383
+ /**
10384
+ * The scopes to be sent when requesting the access token.
10385
+ * @type {string}
10386
+ * @memberof WebhookShared
10387
+ */
10388
+ 'oauth_server_scope'?: string;
10171
10389
  }
10172
10390
  /**
10173
10391
  *
@@ -10212,6 +10430,36 @@ export interface WebhookUpdater {
10212
10430
  * @memberof WebhookUpdater
10213
10431
  */
10214
10432
  'payload_version'?: number;
10433
+ /**
10434
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
10435
+ * @type {boolean}
10436
+ * @memberof WebhookUpdater
10437
+ */
10438
+ 'oauth_enabled'?: boolean;
10439
+ /**
10440
+ * The url to fetch the OAuth access token using client credentials grant.
10441
+ * @type {string}
10442
+ * @memberof WebhookUpdater
10443
+ */
10444
+ 'oauth_server_url'?: string;
10445
+ /**
10446
+ * The client id to authenticate the client credentials grant.
10447
+ * @type {string}
10448
+ * @memberof WebhookUpdater
10449
+ */
10450
+ 'oauth_server_client_id'?: string;
10451
+ /**
10452
+ * The client secret to authenticate the client credentials grant.
10453
+ * @type {string}
10454
+ * @memberof WebhookUpdater
10455
+ */
10456
+ 'oauth_server_client_secret'?: string;
10457
+ /**
10458
+ * The scopes to be sent when requesting the access token.
10459
+ * @type {string}
10460
+ * @memberof WebhookUpdater
10461
+ */
10462
+ 'oauth_server_scope'?: string;
10215
10463
  /**
10216
10464
  * The url that will listen to notifications (must be https).
10217
10465
  * @type {string}
@@ -10832,6 +11080,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
10832
11080
  * @throws {RequiredError}
10833
11081
  */
10834
11082
  findApplicant: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11083
+ /**
11084
+ * Retrieves consents for single applicant.
11085
+ * @summary Retrieve Applicant Consents
11086
+ * @param {string} applicantId
11087
+ * @param {*} [options] Override http request option.
11088
+ * @throws {RequiredError}
11089
+ */
11090
+ findApplicantConsents: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10835
11091
  /**
10836
11092
  * Retrieves a single check. Returns a check object.
10837
11093
  * @summary Retrieve a Check
@@ -11398,6 +11654,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11398
11654
  * @throws {RequiredError}
11399
11655
  */
11400
11656
  findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Applicant>>;
11657
+ /**
11658
+ * Retrieves consents for single applicant.
11659
+ * @summary Retrieve Applicant Consents
11660
+ * @param {string} applicantId
11661
+ * @param {*} [options] Override http request option.
11662
+ * @throws {RequiredError}
11663
+ */
11664
+ findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicantConsent>>>;
11401
11665
  /**
11402
11666
  * Retrieves a single check. Returns a check object.
11403
11667
  * @summary Retrieve a Check
@@ -11964,6 +12228,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
11964
12228
  * @throws {RequiredError}
11965
12229
  */
11966
12230
  findApplicant(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<Applicant>;
12231
+ /**
12232
+ * Retrieves consents for single applicant.
12233
+ * @summary Retrieve Applicant Consents
12234
+ * @param {string} applicantId
12235
+ * @param {*} [options] Override http request option.
12236
+ * @throws {RequiredError}
12237
+ */
12238
+ findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicantConsent>>;
11967
12239
  /**
11968
12240
  * Retrieves a single check. Returns a check object.
11969
12241
  * @summary Retrieve a Check
@@ -12559,6 +12831,15 @@ export declare class DefaultApi extends BaseAPI {
12559
12831
  * @memberof DefaultApi
12560
12832
  */
12561
12833
  findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any>>;
12834
+ /**
12835
+ * Retrieves consents for single applicant.
12836
+ * @summary Retrieve Applicant Consents
12837
+ * @param {string} applicantId
12838
+ * @param {*} [options] Override http request option.
12839
+ * @throws {RequiredError}
12840
+ * @memberof DefaultApi
12841
+ */
12842
+ findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantConsent[], any>>;
12562
12843
  /**
12563
12844
  * Retrieves a single check. Returns a check object.
12564
12845
  * @summary Retrieve a Check
package/dist/api.js CHANGED
@@ -22,8 +22,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.ListWorkflowRunsSortEnum = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WorkflowRunStatus = exports.WorkflowRunLinkLanguageEnum = exports.WebhookEventType = exports.WebhookEventResourceType = exports.WebhookEventObjectStatus = exports.WatchlistMonitorSharedReportNameEnum = exports.WatchlistMonitorBuilderReportNameEnum = exports.WatchlistMonitorReportNameEnum = exports.UsDrivingLicenceSharedGenderEnum = exports.UsDrivingLicenceSharedEyeColorCodeEnum = exports.UsDrivingLicenceSharedDocumentCategoryEnum = exports.UsDrivingLicenceBuilderGenderEnum = exports.UsDrivingLicenceBuilderEyeColorCodeEnum = exports.UsDrivingLicenceBuilderDocumentCategoryEnum = exports.ResultsFeedbackExpectedResultEnum = exports.ReportSubResult = exports.ReportStatus = exports.ReportResult = exports.ReportName = exports.RepeatAttemptsListRepeatAttemptsInnerResultEnum = exports.RepeatAttemptsListRepeatAttemptsInnerNamesEnum = exports.RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum = exports.ProofOfAddressPropertiesDocumentTypeEnum = exports.IdNumberTypeEnum = exports.ExtractionExtractedDataGenderEnum = exports.ExtractionDocumentClassificationSubtypeEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentTypes = exports.DocumentSharedSideEnum = exports.DocumentPropertiesSecurityTierEnum = exports.DocumentPropertiesHasIssuanceConfirmationEnum = exports.DocumentPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentSideEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum = exports.CountryCodes = exports.CheckStatus = exports.CheckResponseResultEnum = exports.CheckResultEnum = exports.ApplicantConsentName = void 0;
26
- exports.UploadDocumentSideEnum = void 0;
25
+ exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WorkflowRunStatus = exports.WorkflowRunLinkLanguageEnum = exports.WebhookEventType = exports.WebhookEventResourceType = exports.WebhookEventObjectStatus = exports.WatchlistMonitorSharedReportNameEnum = exports.WatchlistMonitorBuilderReportNameEnum = exports.WatchlistMonitorReportNameEnum = exports.UsDrivingLicenceSharedGenderEnum = exports.UsDrivingLicenceSharedEyeColorCodeEnum = exports.UsDrivingLicenceSharedDocumentCategoryEnum = exports.UsDrivingLicenceBuilderGenderEnum = exports.UsDrivingLicenceBuilderEyeColorCodeEnum = exports.UsDrivingLicenceBuilderDocumentCategoryEnum = exports.ResultsFeedbackExpectedResultEnum = exports.ReportSubResult = exports.ReportStatus = exports.ReportResult = exports.ReportName = exports.ReportConfigurationFacialSimilarityUseCaseEnum = exports.RepeatAttemptsListRepeatAttemptsInnerResultEnum = exports.RepeatAttemptsListRepeatAttemptsInnerNamesEnum = exports.RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum = exports.ProofOfAddressPropertiesDocumentTypeEnum = exports.IdNumberTypeEnum = exports.ExtractionExtractedDataGenderEnum = exports.ExtractionDocumentClassificationSubtypeEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentTypes = exports.DocumentSharedSideEnum = exports.DocumentPropertiesSecurityTierEnum = exports.DocumentPropertiesHasIssuanceConfirmationEnum = exports.DocumentPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentSideEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum = exports.CountryCodes = exports.CheckStatus = exports.CheckResponseResultEnum = exports.CheckResultEnum = exports.ApplicantConsentName = void 0;
26
+ exports.UploadDocumentSideEnum = exports.ListWorkflowRunsSortEnum = void 0;
27
27
  const axios_1 = require("axios");
28
28
  // URLSearchParams not necessarily used
29
29
  // @ts-ignore
@@ -567,6 +567,11 @@ exports.RepeatAttemptsListRepeatAttemptsInnerResultEnum = {
567
567
  Consider: 'consider',
568
568
  UnknownDefaultOpenApi: '11184809'
569
569
  };
570
+ exports.ReportConfigurationFacialSimilarityUseCaseEnum = {
571
+ Onboarding: 'onboarding',
572
+ Reverification: 'reverification',
573
+ UnknownDefaultOpenApi: '11184809'
574
+ };
570
575
  /**
571
576
  *
572
577
  * @export
@@ -1660,6 +1665,37 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1660
1665
  options: localVarRequestOptions,
1661
1666
  };
1662
1667
  }),
1668
+ /**
1669
+ * Retrieves consents for single applicant.
1670
+ * @summary Retrieve Applicant Consents
1671
+ * @param {string} applicantId
1672
+ * @param {*} [options] Override http request option.
1673
+ * @throws {RequiredError}
1674
+ */
1675
+ findApplicantConsents: (applicantId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1676
+ // verify required parameter 'applicantId' is not null or undefined
1677
+ (0, common_1.assertParamExists)('findApplicantConsents', 'applicantId', applicantId);
1678
+ const localVarPath = `/applicants/{applicant_id}/consents`
1679
+ .replace(`{${"applicant_id"}}`, encodeURIComponent(String(applicantId)));
1680
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1681
+ const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
1682
+ let baseOptions;
1683
+ if (configuration) {
1684
+ baseOptions = configuration.baseOptions;
1685
+ }
1686
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1687
+ const localVarHeaderParameter = {};
1688
+ const localVarQueryParameter = {};
1689
+ // authentication Token required
1690
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
1691
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1692
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1693
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1694
+ return {
1695
+ url: (0, common_1.toPathString)(localVarUrlObj),
1696
+ options: localVarRequestOptions,
1697
+ };
1698
+ }),
1663
1699
  /**
1664
1700
  * Retrieves a single check. Returns a check object.
1665
1701
  * @summary Retrieve a Check
@@ -3470,6 +3506,22 @@ const DefaultApiFp = function (configuration) {
3470
3506
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3471
3507
  });
3472
3508
  },
3509
+ /**
3510
+ * Retrieves consents for single applicant.
3511
+ * @summary Retrieve Applicant Consents
3512
+ * @param {string} applicantId
3513
+ * @param {*} [options] Override http request option.
3514
+ * @throws {RequiredError}
3515
+ */
3516
+ findApplicantConsents(applicantId, options) {
3517
+ var _a, _b, _c;
3518
+ return __awaiter(this, void 0, void 0, function* () {
3519
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.findApplicantConsents(applicantId, options);
3520
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3521
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.findApplicantConsents']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3522
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3523
+ });
3524
+ },
3473
3525
  /**
3474
3526
  * Retrieves a single check. Returns a check object.
3475
3527
  * @summary Retrieve a Check
@@ -4414,6 +4466,16 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
4414
4466
  findApplicant(applicantId, options) {
4415
4467
  return localVarFp.findApplicant(applicantId, options).then((request) => request(axios, basePath));
4416
4468
  },
4469
+ /**
4470
+ * Retrieves consents for single applicant.
4471
+ * @summary Retrieve Applicant Consents
4472
+ * @param {string} applicantId
4473
+ * @param {*} [options] Override http request option.
4474
+ * @throws {RequiredError}
4475
+ */
4476
+ findApplicantConsents(applicantId, options) {
4477
+ return localVarFp.findApplicantConsents(applicantId, options).then((request) => request(axios, basePath));
4478
+ },
4417
4479
  /**
4418
4480
  * Retrieves a single check. Returns a check object.
4419
4481
  * @summary Retrieve a Check
@@ -5145,6 +5207,17 @@ class DefaultApi extends base_1.BaseAPI {
5145
5207
  findApplicant(applicantId, options) {
5146
5208
  return (0, exports.DefaultApiFp)(this.configuration).findApplicant(applicantId, options).then((request) => request(this.axios, this.basePath));
5147
5209
  }
5210
+ /**
5211
+ * Retrieves consents for single applicant.
5212
+ * @summary Retrieve Applicant Consents
5213
+ * @param {string} applicantId
5214
+ * @param {*} [options] Override http request option.
5215
+ * @throws {RequiredError}
5216
+ * @memberof DefaultApi
5217
+ */
5218
+ findApplicantConsents(applicantId, options) {
5219
+ return (0, exports.DefaultApiFp)(this.configuration).findApplicantConsents(applicantId, options).then((request) => request(this.axios, this.basePath));
5220
+ }
5148
5221
  /**
5149
5222
  * Retrieves a single check. Returns a check object.
5150
5223
  * @summary Retrieve a Check
@@ -32,7 +32,7 @@ class Configuration {
32
32
  }
33
33
  this.apiKey = 'Token token=' + param.apiToken;
34
34
  this.basePath = param.basePath || base_1.BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
35
- this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "onfido-node/5.0.0" }) });
35
+ this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "onfido-node/5.2.0" }) });
36
36
  this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
37
37
  }
38
38
  /**
package/dist/esm/api.d.ts CHANGED
@@ -410,6 +410,31 @@ export interface ApplicantBuilder {
410
410
  */
411
411
  'last_name': string;
412
412
  }
413
+ /**
414
+ *
415
+ * @export
416
+ * @interface ApplicantConsent
417
+ */
418
+ export interface ApplicantConsent {
419
+ /**
420
+ *
421
+ * @type {ApplicantConsentName}
422
+ * @memberof ApplicantConsent
423
+ */
424
+ 'name': ApplicantConsentName;
425
+ /**
426
+ *
427
+ * @type {boolean}
428
+ * @memberof ApplicantConsent
429
+ */
430
+ 'granted': boolean;
431
+ /**
432
+ * The date and time when this applicant consent was granted, if not granted the value is nil.
433
+ * @type {string}
434
+ * @memberof ApplicantConsent
435
+ */
436
+ 'granted_at': string | null;
437
+ }
413
438
  /**
414
439
  *
415
440
  * @export
@@ -869,6 +894,13 @@ export interface CheckBuilder {
869
894
  * @memberof CheckBuilder
870
895
  */
871
896
  'us_driving_licence'?: UsDrivingLicenceBuilder;
897
+ /**
898
+ *
899
+ * @type {ReportConfiguration}
900
+ * @memberof CheckBuilder
901
+ * @deprecated
902
+ */
903
+ 'report_configuration'?: ReportConfiguration;
872
904
  }
873
905
  /**
874
906
  *
@@ -924,6 +956,13 @@ export interface CheckRequest {
924
956
  * @memberof CheckRequest
925
957
  */
926
958
  'us_driving_licence'?: UsDrivingLicenceBuilder;
959
+ /**
960
+ *
961
+ * @type {ReportConfiguration}
962
+ * @memberof CheckRequest
963
+ * @deprecated
964
+ */
965
+ 'report_configuration'?: ReportConfiguration;
927
966
  }
928
967
  /**
929
968
  *
@@ -1359,16 +1398,24 @@ export type CountryCodes = typeof CountryCodes[keyof typeof CountryCodes];
1359
1398
  * @interface DeviceIntelligenceBreakdown
1360
1399
  */
1361
1400
  export interface DeviceIntelligenceBreakdown {
1401
+ /**
1402
+ *
1403
+ * @type {DeviceIntelligenceBreakdownDevice}
1404
+ * @memberof DeviceIntelligenceBreakdown
1405
+ */
1406
+ 'device'?: DeviceIntelligenceBreakdownDevice;
1362
1407
  /**
1363
1408
  *
1364
1409
  * @type {DeviceIntelligenceBreakdownBreakdown}
1365
1410
  * @memberof DeviceIntelligenceBreakdown
1411
+ * @deprecated
1366
1412
  */
1367
1413
  'breakdown'?: DeviceIntelligenceBreakdownBreakdown;
1368
1414
  /**
1369
1415
  *
1370
1416
  * @type {DeviceIntelligenceBreakdownProperties}
1371
1417
  * @memberof DeviceIntelligenceBreakdown
1418
+ * @deprecated
1372
1419
  */
1373
1420
  'properties'?: DeviceIntelligenceBreakdownProperties;
1374
1421
  }
@@ -1380,46 +1427,46 @@ export interface DeviceIntelligenceBreakdown {
1380
1427
  export interface DeviceIntelligenceBreakdownBreakdown {
1381
1428
  /**
1382
1429
  *
1383
- * @type {DeviceIntelligenceBreakdownBreakdownDevice}
1430
+ * @type {DeviceIntelligenceBreakdownDevice}
1384
1431
  * @memberof DeviceIntelligenceBreakdownBreakdown
1385
1432
  */
1386
- 'device'?: DeviceIntelligenceBreakdownBreakdownDevice;
1433
+ 'device'?: DeviceIntelligenceBreakdownDevice;
1387
1434
  }
1388
1435
  /**
1389
1436
  * Asserts whether the device used to upload the media is trustworthy, i.e. it is a real, physical device.
1390
1437
  * @export
1391
- * @interface DeviceIntelligenceBreakdownBreakdownDevice
1438
+ * @interface DeviceIntelligenceBreakdownDevice
1392
1439
  */
1393
- export interface DeviceIntelligenceBreakdownBreakdownDevice {
1440
+ export interface DeviceIntelligenceBreakdownDevice {
1394
1441
  /**
1395
1442
  *
1396
- * @type {DeviceIntelligenceBreakdownBreakdownDeviceBreakdown}
1397
- * @memberof DeviceIntelligenceBreakdownBreakdownDevice
1443
+ * @type {DeviceIntelligenceBreakdownDeviceBreakdown}
1444
+ * @memberof DeviceIntelligenceBreakdownDevice
1398
1445
  */
1399
- 'breakdown'?: DeviceIntelligenceBreakdownBreakdownDeviceBreakdown;
1446
+ 'breakdown'?: DeviceIntelligenceBreakdownDeviceBreakdown;
1400
1447
  }
1401
1448
  /**
1402
1449
  *
1403
1450
  * @export
1404
- * @interface DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1451
+ * @interface DeviceIntelligenceBreakdownDeviceBreakdown
1405
1452
  */
1406
- export interface DeviceIntelligenceBreakdownBreakdownDeviceBreakdown {
1453
+ export interface DeviceIntelligenceBreakdownDeviceBreakdown {
1407
1454
  /**
1408
1455
  *
1409
1456
  * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
1410
- * @memberof DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1457
+ * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
1411
1458
  */
1412
1459
  'application_authenticity'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
1413
1460
  /**
1414
1461
  *
1415
1462
  * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
1416
- * @memberof DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1463
+ * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
1417
1464
  */
1418
1465
  'device_integrity'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
1419
1466
  /**
1420
1467
  *
1421
1468
  * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
1422
- * @memberof DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1469
+ * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
1423
1470
  */
1424
1471
  'device_reputation'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
1425
1472
  }
@@ -1610,6 +1657,31 @@ export interface DeviceIntelligenceBreakdownPropertiesIp {
1610
1657
  */
1611
1658
  'address'?: string;
1612
1659
  }
1660
+ /**
1661
+ *
1662
+ * @export
1663
+ * @interface DeviceIntelligenceProperties
1664
+ */
1665
+ export interface DeviceIntelligenceProperties {
1666
+ /**
1667
+ *
1668
+ * @type {DeviceIntelligenceBreakdownPropertiesDevice}
1669
+ * @memberof DeviceIntelligenceProperties
1670
+ */
1671
+ 'device'?: DeviceIntelligenceBreakdownPropertiesDevice;
1672
+ /**
1673
+ *
1674
+ * @type {DeviceIntelligenceBreakdownPropertiesIp}
1675
+ * @memberof DeviceIntelligenceProperties
1676
+ */
1677
+ 'ip'?: DeviceIntelligenceBreakdownPropertiesIp;
1678
+ /**
1679
+ *
1680
+ * @type {DeviceIntelligenceBreakdownPropertiesGeolocation}
1681
+ * @memberof DeviceIntelligenceProperties
1682
+ */
1683
+ 'geolocation'?: DeviceIntelligenceBreakdownPropertiesGeolocation;
1684
+ }
1613
1685
  /**
1614
1686
  *
1615
1687
  * @export
@@ -1670,6 +1742,12 @@ export interface DeviceIntelligenceReport {
1670
1742
  * @memberof DeviceIntelligenceReport
1671
1743
  */
1672
1744
  'breakdown'?: DeviceIntelligenceBreakdown;
1745
+ /**
1746
+ *
1747
+ * @type {DeviceIntelligenceProperties}
1748
+ * @memberof DeviceIntelligenceReport
1749
+ */
1750
+ 'properties'?: DeviceIntelligenceProperties;
1673
1751
  }
1674
1752
  /**
1675
1753
  *
@@ -3020,10 +3098,10 @@ export interface DocumentProperties {
3020
3098
  'nfc'?: DocumentPropertiesNfc;
3021
3099
  /**
3022
3100
  *
3023
- * @type {DocumentPropertiesDrivingLicenceInformation}
3101
+ * @type {Array<DocumentPropertiesDrivingLicenceInformationItem>}
3024
3102
  * @memberof DocumentProperties
3025
3103
  */
3026
- 'driving_licence_information'?: DocumentPropertiesDrivingLicenceInformation;
3104
+ 'driving_licence_information'?: Array<DocumentPropertiesDrivingLicenceInformationItem>;
3027
3105
  /**
3028
3106
  *
3029
3107
  * @type {DocumentPropertiesDocumentClassification}
@@ -3269,31 +3347,31 @@ export interface DocumentPropertiesDocumentNumbersInner {
3269
3347
  /**
3270
3348
  *
3271
3349
  * @export
3272
- * @interface DocumentPropertiesDrivingLicenceInformation
3350
+ * @interface DocumentPropertiesDrivingLicenceInformationItem
3273
3351
  */
3274
- export interface DocumentPropertiesDrivingLicenceInformation {
3352
+ export interface DocumentPropertiesDrivingLicenceInformationItem {
3275
3353
  /**
3276
3354
  *
3277
3355
  * @type {string}
3278
- * @memberof DocumentPropertiesDrivingLicenceInformation
3356
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3279
3357
  */
3280
3358
  'category'?: string;
3281
3359
  /**
3282
3360
  *
3283
3361
  * @type {string}
3284
- * @memberof DocumentPropertiesDrivingLicenceInformation
3362
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3285
3363
  */
3286
3364
  'obtainment_date'?: string;
3287
3365
  /**
3288
3366
  *
3289
3367
  * @type {string}
3290
- * @memberof DocumentPropertiesDrivingLicenceInformation
3368
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3291
3369
  */
3292
3370
  'expiry_date'?: string;
3293
3371
  /**
3294
3372
  *
3295
3373
  * @type {string}
3296
- * @memberof DocumentPropertiesDrivingLicenceInformation
3374
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3297
3375
  */
3298
3376
  'codes'?: string;
3299
3377
  }
@@ -4324,10 +4402,10 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4324
4402
  'nfc'?: DocumentPropertiesNfc;
4325
4403
  /**
4326
4404
  *
4327
- * @type {DocumentPropertiesDrivingLicenceInformation}
4405
+ * @type {Array<DocumentPropertiesDrivingLicenceInformationItem>}
4328
4406
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4329
4407
  */
4330
- 'driving_licence_information'?: DocumentPropertiesDrivingLicenceInformation;
4408
+ 'driving_licence_information'?: Array<DocumentPropertiesDrivingLicenceInformationItem>;
4331
4409
  /**
4332
4410
  *
4333
4411
  * @type {DocumentPropertiesDocumentClassification}
@@ -7728,6 +7806,56 @@ export type Report = {
7728
7806
  } & WatchlistSanctionsOnlyReport | {
7729
7807
  name: 'watchlist_standard';
7730
7808
  } & WatchlistStandardReport;
7809
+ /**
7810
+ * Defines configuration options for facial similarity checks used to distinguish between onboarding and reverification scenarios.
7811
+ * @export
7812
+ * @interface ReportConfiguration
7813
+ */
7814
+ export interface ReportConfiguration {
7815
+ /**
7816
+ *
7817
+ * @type {ReportConfigurationFacialSimilarity}
7818
+ * @memberof ReportConfiguration
7819
+ */
7820
+ 'facial_similarity_photo'?: ReportConfigurationFacialSimilarity;
7821
+ /**
7822
+ *
7823
+ * @type {ReportConfigurationFacialSimilarity}
7824
+ * @memberof ReportConfiguration
7825
+ */
7826
+ 'facial_similarity_photo_fully_auto'?: ReportConfigurationFacialSimilarity;
7827
+ /**
7828
+ *
7829
+ * @type {ReportConfigurationFacialSimilarity}
7830
+ * @memberof ReportConfiguration
7831
+ */
7832
+ 'facial_similarity_video'?: ReportConfigurationFacialSimilarity;
7833
+ /**
7834
+ *
7835
+ * @type {ReportConfigurationFacialSimilarity}
7836
+ * @memberof ReportConfiguration
7837
+ */
7838
+ 'facial_similarity_motion'?: ReportConfigurationFacialSimilarity;
7839
+ }
7840
+ /**
7841
+ *
7842
+ * @export
7843
+ * @interface ReportConfigurationFacialSimilarity
7844
+ */
7845
+ export interface ReportConfigurationFacialSimilarity {
7846
+ /**
7847
+ * You should set it to \"reverification\" on a post-onboarding scenario (e.g. ongoing authentication).
7848
+ * @type {string}
7849
+ * @memberof ReportConfigurationFacialSimilarity
7850
+ */
7851
+ 'use_case'?: ReportConfigurationFacialSimilarityUseCaseEnum;
7852
+ }
7853
+ export declare const ReportConfigurationFacialSimilarityUseCaseEnum: {
7854
+ readonly Onboarding: "onboarding";
7855
+ readonly Reverification: "reverification";
7856
+ readonly UnknownDefaultOpenApi: "11184809";
7857
+ };
7858
+ export type ReportConfigurationFacialSimilarityUseCaseEnum = typeof ReportConfigurationFacialSimilarityUseCaseEnum[keyof typeof ReportConfigurationFacialSimilarityUseCaseEnum];
7731
7859
  /**
7732
7860
  *
7733
7861
  * @export
@@ -9764,6 +9892,36 @@ export interface Webhook {
9764
9892
  * @memberof Webhook
9765
9893
  */
9766
9894
  'payload_version'?: number;
9895
+ /**
9896
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
9897
+ * @type {boolean}
9898
+ * @memberof Webhook
9899
+ */
9900
+ 'oauth_enabled'?: boolean;
9901
+ /**
9902
+ * The url to fetch the OAuth access token using client credentials grant.
9903
+ * @type {string}
9904
+ * @memberof Webhook
9905
+ */
9906
+ 'oauth_server_url'?: string;
9907
+ /**
9908
+ * The client id to authenticate the client credentials grant.
9909
+ * @type {string}
9910
+ * @memberof Webhook
9911
+ */
9912
+ 'oauth_server_client_id'?: string;
9913
+ /**
9914
+ * The client secret to authenticate the client credentials grant.
9915
+ * @type {string}
9916
+ * @memberof Webhook
9917
+ */
9918
+ 'oauth_server_client_secret'?: string;
9919
+ /**
9920
+ * The scopes to be sent when requesting the access token.
9921
+ * @type {string}
9922
+ * @memberof Webhook
9923
+ */
9924
+ 'oauth_server_scope'?: string;
9767
9925
  /**
9768
9926
  * The unique identifier of the webhook.
9769
9927
  * @type {string}
@@ -9819,6 +9977,36 @@ export interface WebhookBuilder {
9819
9977
  * @memberof WebhookBuilder
9820
9978
  */
9821
9979
  'payload_version'?: number;
9980
+ /**
9981
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
9982
+ * @type {boolean}
9983
+ * @memberof WebhookBuilder
9984
+ */
9985
+ 'oauth_enabled'?: boolean;
9986
+ /**
9987
+ * The url to fetch the OAuth access token using client credentials grant.
9988
+ * @type {string}
9989
+ * @memberof WebhookBuilder
9990
+ */
9991
+ 'oauth_server_url'?: string;
9992
+ /**
9993
+ * The client id to authenticate the client credentials grant.
9994
+ * @type {string}
9995
+ * @memberof WebhookBuilder
9996
+ */
9997
+ 'oauth_server_client_id'?: string;
9998
+ /**
9999
+ * The client secret to authenticate the client credentials grant.
10000
+ * @type {string}
10001
+ * @memberof WebhookBuilder
10002
+ */
10003
+ 'oauth_server_client_secret'?: string;
10004
+ /**
10005
+ * The scopes to be sent when requesting the access token.
10006
+ * @type {string}
10007
+ * @memberof WebhookBuilder
10008
+ */
10009
+ 'oauth_server_scope'?: string;
9822
10010
  /**
9823
10011
  * The url that will listen to notifications (must be https).
9824
10012
  * @type {string}
@@ -10168,6 +10356,36 @@ export interface WebhookShared {
10168
10356
  * @memberof WebhookShared
10169
10357
  */
10170
10358
  'payload_version'?: number;
10359
+ /**
10360
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
10361
+ * @type {boolean}
10362
+ * @memberof WebhookShared
10363
+ */
10364
+ 'oauth_enabled'?: boolean;
10365
+ /**
10366
+ * The url to fetch the OAuth access token using client credentials grant.
10367
+ * @type {string}
10368
+ * @memberof WebhookShared
10369
+ */
10370
+ 'oauth_server_url'?: string;
10371
+ /**
10372
+ * The client id to authenticate the client credentials grant.
10373
+ * @type {string}
10374
+ * @memberof WebhookShared
10375
+ */
10376
+ 'oauth_server_client_id'?: string;
10377
+ /**
10378
+ * The client secret to authenticate the client credentials grant.
10379
+ * @type {string}
10380
+ * @memberof WebhookShared
10381
+ */
10382
+ 'oauth_server_client_secret'?: string;
10383
+ /**
10384
+ * The scopes to be sent when requesting the access token.
10385
+ * @type {string}
10386
+ * @memberof WebhookShared
10387
+ */
10388
+ 'oauth_server_scope'?: string;
10171
10389
  }
10172
10390
  /**
10173
10391
  *
@@ -10212,6 +10430,36 @@ export interface WebhookUpdater {
10212
10430
  * @memberof WebhookUpdater
10213
10431
  */
10214
10432
  'payload_version'?: number;
10433
+ /**
10434
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
10435
+ * @type {boolean}
10436
+ * @memberof WebhookUpdater
10437
+ */
10438
+ 'oauth_enabled'?: boolean;
10439
+ /**
10440
+ * The url to fetch the OAuth access token using client credentials grant.
10441
+ * @type {string}
10442
+ * @memberof WebhookUpdater
10443
+ */
10444
+ 'oauth_server_url'?: string;
10445
+ /**
10446
+ * The client id to authenticate the client credentials grant.
10447
+ * @type {string}
10448
+ * @memberof WebhookUpdater
10449
+ */
10450
+ 'oauth_server_client_id'?: string;
10451
+ /**
10452
+ * The client secret to authenticate the client credentials grant.
10453
+ * @type {string}
10454
+ * @memberof WebhookUpdater
10455
+ */
10456
+ 'oauth_server_client_secret'?: string;
10457
+ /**
10458
+ * The scopes to be sent when requesting the access token.
10459
+ * @type {string}
10460
+ * @memberof WebhookUpdater
10461
+ */
10462
+ 'oauth_server_scope'?: string;
10215
10463
  /**
10216
10464
  * The url that will listen to notifications (must be https).
10217
10465
  * @type {string}
@@ -10832,6 +11080,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
10832
11080
  * @throws {RequiredError}
10833
11081
  */
10834
11082
  findApplicant: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11083
+ /**
11084
+ * Retrieves consents for single applicant.
11085
+ * @summary Retrieve Applicant Consents
11086
+ * @param {string} applicantId
11087
+ * @param {*} [options] Override http request option.
11088
+ * @throws {RequiredError}
11089
+ */
11090
+ findApplicantConsents: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10835
11091
  /**
10836
11092
  * Retrieves a single check. Returns a check object.
10837
11093
  * @summary Retrieve a Check
@@ -11398,6 +11654,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11398
11654
  * @throws {RequiredError}
11399
11655
  */
11400
11656
  findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Applicant>>;
11657
+ /**
11658
+ * Retrieves consents for single applicant.
11659
+ * @summary Retrieve Applicant Consents
11660
+ * @param {string} applicantId
11661
+ * @param {*} [options] Override http request option.
11662
+ * @throws {RequiredError}
11663
+ */
11664
+ findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicantConsent>>>;
11401
11665
  /**
11402
11666
  * Retrieves a single check. Returns a check object.
11403
11667
  * @summary Retrieve a Check
@@ -11964,6 +12228,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
11964
12228
  * @throws {RequiredError}
11965
12229
  */
11966
12230
  findApplicant(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<Applicant>;
12231
+ /**
12232
+ * Retrieves consents for single applicant.
12233
+ * @summary Retrieve Applicant Consents
12234
+ * @param {string} applicantId
12235
+ * @param {*} [options] Override http request option.
12236
+ * @throws {RequiredError}
12237
+ */
12238
+ findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicantConsent>>;
11967
12239
  /**
11968
12240
  * Retrieves a single check. Returns a check object.
11969
12241
  * @summary Retrieve a Check
@@ -12559,6 +12831,15 @@ export declare class DefaultApi extends BaseAPI {
12559
12831
  * @memberof DefaultApi
12560
12832
  */
12561
12833
  findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any>>;
12834
+ /**
12835
+ * Retrieves consents for single applicant.
12836
+ * @summary Retrieve Applicant Consents
12837
+ * @param {string} applicantId
12838
+ * @param {*} [options] Override http request option.
12839
+ * @throws {RequiredError}
12840
+ * @memberof DefaultApi
12841
+ */
12842
+ findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantConsent[], any>>;
12562
12843
  /**
12563
12844
  * Retrieves a single check. Returns a check object.
12564
12845
  * @summary Retrieve a Check
package/dist/esm/api.js CHANGED
@@ -563,6 +563,11 @@ export const RepeatAttemptsListRepeatAttemptsInnerResultEnum = {
563
563
  Consider: 'consider',
564
564
  UnknownDefaultOpenApi: '11184809'
565
565
  };
566
+ export const ReportConfigurationFacialSimilarityUseCaseEnum = {
567
+ Onboarding: 'onboarding',
568
+ Reverification: 'reverification',
569
+ UnknownDefaultOpenApi: '11184809'
570
+ };
566
571
  /**
567
572
  *
568
573
  * @export
@@ -1656,6 +1661,37 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
1656
1661
  options: localVarRequestOptions,
1657
1662
  };
1658
1663
  }),
1664
+ /**
1665
+ * Retrieves consents for single applicant.
1666
+ * @summary Retrieve Applicant Consents
1667
+ * @param {string} applicantId
1668
+ * @param {*} [options] Override http request option.
1669
+ * @throws {RequiredError}
1670
+ */
1671
+ findApplicantConsents: (applicantId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1672
+ // verify required parameter 'applicantId' is not null or undefined
1673
+ assertParamExists('findApplicantConsents', 'applicantId', applicantId);
1674
+ const localVarPath = `/applicants/{applicant_id}/consents`
1675
+ .replace(`{${"applicant_id"}}`, encodeURIComponent(String(applicantId)));
1676
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1677
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1678
+ let baseOptions;
1679
+ if (configuration) {
1680
+ baseOptions = configuration.baseOptions;
1681
+ }
1682
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1683
+ const localVarHeaderParameter = {};
1684
+ const localVarQueryParameter = {};
1685
+ // authentication Token required
1686
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1687
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1688
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1689
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1690
+ return {
1691
+ url: toPathString(localVarUrlObj),
1692
+ options: localVarRequestOptions,
1693
+ };
1694
+ }),
1659
1695
  /**
1660
1696
  * Retrieves a single check. Returns a check object.
1661
1697
  * @summary Retrieve a Check
@@ -3465,6 +3501,22 @@ export const DefaultApiFp = function (configuration) {
3465
3501
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3466
3502
  });
3467
3503
  },
3504
+ /**
3505
+ * Retrieves consents for single applicant.
3506
+ * @summary Retrieve Applicant Consents
3507
+ * @param {string} applicantId
3508
+ * @param {*} [options] Override http request option.
3509
+ * @throws {RequiredError}
3510
+ */
3511
+ findApplicantConsents(applicantId, options) {
3512
+ var _a, _b, _c;
3513
+ return __awaiter(this, void 0, void 0, function* () {
3514
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.findApplicantConsents(applicantId, options);
3515
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3516
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.findApplicantConsents']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3517
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3518
+ });
3519
+ },
3468
3520
  /**
3469
3521
  * Retrieves a single check. Returns a check object.
3470
3522
  * @summary Retrieve a Check
@@ -4408,6 +4460,16 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4408
4460
  findApplicant(applicantId, options) {
4409
4461
  return localVarFp.findApplicant(applicantId, options).then((request) => request(axios, basePath));
4410
4462
  },
4463
+ /**
4464
+ * Retrieves consents for single applicant.
4465
+ * @summary Retrieve Applicant Consents
4466
+ * @param {string} applicantId
4467
+ * @param {*} [options] Override http request option.
4468
+ * @throws {RequiredError}
4469
+ */
4470
+ findApplicantConsents(applicantId, options) {
4471
+ return localVarFp.findApplicantConsents(applicantId, options).then((request) => request(axios, basePath));
4472
+ },
4411
4473
  /**
4412
4474
  * Retrieves a single check. Returns a check object.
4413
4475
  * @summary Retrieve a Check
@@ -5138,6 +5200,17 @@ export class DefaultApi extends BaseAPI {
5138
5200
  findApplicant(applicantId, options) {
5139
5201
  return DefaultApiFp(this.configuration).findApplicant(applicantId, options).then((request) => request(this.axios, this.basePath));
5140
5202
  }
5203
+ /**
5204
+ * Retrieves consents for single applicant.
5205
+ * @summary Retrieve Applicant Consents
5206
+ * @param {string} applicantId
5207
+ * @param {*} [options] Override http request option.
5208
+ * @throws {RequiredError}
5209
+ * @memberof DefaultApi
5210
+ */
5211
+ findApplicantConsents(applicantId, options) {
5212
+ return DefaultApiFp(this.configuration).findApplicantConsents(applicantId, options).then((request) => request(this.axios, this.basePath));
5213
+ }
5141
5214
  /**
5142
5215
  * Retrieves a single check. Returns a check object.
5143
5216
  * @summary Retrieve a Check
@@ -29,7 +29,7 @@ export class Configuration {
29
29
  }
30
30
  this.apiKey = 'Token token=' + param.apiToken;
31
31
  this.basePath = param.basePath || BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
32
- this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "onfido-node/5.0.0" }) });
32
+ this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "onfido-node/5.2.0" }) });
33
33
  this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
34
34
  }
35
35
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onfido/api",
3
- "version": "5.0.0",
3
+ "version": "5.2.0",
4
4
  "description": "Node.js library for the Onfido API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {