@onfido/api 4.6.0 → 5.1.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
@@ -1359,16 +1384,24 @@ export type CountryCodes = typeof CountryCodes[keyof typeof CountryCodes];
1359
1384
  * @interface DeviceIntelligenceBreakdown
1360
1385
  */
1361
1386
  export interface DeviceIntelligenceBreakdown {
1387
+ /**
1388
+ *
1389
+ * @type {DeviceIntelligenceBreakdownDevice}
1390
+ * @memberof DeviceIntelligenceBreakdown
1391
+ */
1392
+ 'device'?: DeviceIntelligenceBreakdownDevice;
1362
1393
  /**
1363
1394
  *
1364
1395
  * @type {DeviceIntelligenceBreakdownBreakdown}
1365
1396
  * @memberof DeviceIntelligenceBreakdown
1397
+ * @deprecated
1366
1398
  */
1367
1399
  'breakdown'?: DeviceIntelligenceBreakdownBreakdown;
1368
1400
  /**
1369
1401
  *
1370
1402
  * @type {DeviceIntelligenceBreakdownProperties}
1371
1403
  * @memberof DeviceIntelligenceBreakdown
1404
+ * @deprecated
1372
1405
  */
1373
1406
  'properties'?: DeviceIntelligenceBreakdownProperties;
1374
1407
  }
@@ -1380,46 +1413,46 @@ export interface DeviceIntelligenceBreakdown {
1380
1413
  export interface DeviceIntelligenceBreakdownBreakdown {
1381
1414
  /**
1382
1415
  *
1383
- * @type {DeviceIntelligenceBreakdownBreakdownDevice}
1416
+ * @type {DeviceIntelligenceBreakdownDevice}
1384
1417
  * @memberof DeviceIntelligenceBreakdownBreakdown
1385
1418
  */
1386
- 'device'?: DeviceIntelligenceBreakdownBreakdownDevice;
1419
+ 'device'?: DeviceIntelligenceBreakdownDevice;
1387
1420
  }
1388
1421
  /**
1389
1422
  * Asserts whether the device used to upload the media is trustworthy, i.e. it is a real, physical device.
1390
1423
  * @export
1391
- * @interface DeviceIntelligenceBreakdownBreakdownDevice
1424
+ * @interface DeviceIntelligenceBreakdownDevice
1392
1425
  */
1393
- export interface DeviceIntelligenceBreakdownBreakdownDevice {
1426
+ export interface DeviceIntelligenceBreakdownDevice {
1394
1427
  /**
1395
1428
  *
1396
- * @type {DeviceIntelligenceBreakdownBreakdownDeviceBreakdown}
1397
- * @memberof DeviceIntelligenceBreakdownBreakdownDevice
1429
+ * @type {DeviceIntelligenceBreakdownDeviceBreakdown}
1430
+ * @memberof DeviceIntelligenceBreakdownDevice
1398
1431
  */
1399
- 'breakdown'?: DeviceIntelligenceBreakdownBreakdownDeviceBreakdown;
1432
+ 'breakdown'?: DeviceIntelligenceBreakdownDeviceBreakdown;
1400
1433
  }
1401
1434
  /**
1402
1435
  *
1403
1436
  * @export
1404
- * @interface DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1437
+ * @interface DeviceIntelligenceBreakdownDeviceBreakdown
1405
1438
  */
1406
- export interface DeviceIntelligenceBreakdownBreakdownDeviceBreakdown {
1439
+ export interface DeviceIntelligenceBreakdownDeviceBreakdown {
1407
1440
  /**
1408
1441
  *
1409
1442
  * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
1410
- * @memberof DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1443
+ * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
1411
1444
  */
1412
1445
  'application_authenticity'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
1413
1446
  /**
1414
1447
  *
1415
1448
  * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
1416
- * @memberof DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1449
+ * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
1417
1450
  */
1418
1451
  'device_integrity'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
1419
1452
  /**
1420
1453
  *
1421
1454
  * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
1422
- * @memberof DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
1455
+ * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
1423
1456
  */
1424
1457
  'device_reputation'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
1425
1458
  }
@@ -1610,6 +1643,31 @@ export interface DeviceIntelligenceBreakdownPropertiesIp {
1610
1643
  */
1611
1644
  'address'?: string;
1612
1645
  }
1646
+ /**
1647
+ *
1648
+ * @export
1649
+ * @interface DeviceIntelligenceProperties
1650
+ */
1651
+ export interface DeviceIntelligenceProperties {
1652
+ /**
1653
+ *
1654
+ * @type {DeviceIntelligenceBreakdownPropertiesDevice}
1655
+ * @memberof DeviceIntelligenceProperties
1656
+ */
1657
+ 'device'?: DeviceIntelligenceBreakdownPropertiesDevice;
1658
+ /**
1659
+ *
1660
+ * @type {DeviceIntelligenceBreakdownPropertiesIp}
1661
+ * @memberof DeviceIntelligenceProperties
1662
+ */
1663
+ 'ip'?: DeviceIntelligenceBreakdownPropertiesIp;
1664
+ /**
1665
+ *
1666
+ * @type {DeviceIntelligenceBreakdownPropertiesGeolocation}
1667
+ * @memberof DeviceIntelligenceProperties
1668
+ */
1669
+ 'geolocation'?: DeviceIntelligenceBreakdownPropertiesGeolocation;
1670
+ }
1613
1671
  /**
1614
1672
  *
1615
1673
  * @export
@@ -1658,12 +1716,6 @@ export interface DeviceIntelligenceReport {
1658
1716
  * @memberof DeviceIntelligenceReport
1659
1717
  */
1660
1718
  'check_id'?: string;
1661
- /**
1662
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
1663
- * @type {Array<ReportDocument>}
1664
- * @memberof DeviceIntelligenceReport
1665
- */
1666
- 'documents'?: Array<ReportDocument>;
1667
1719
  /**
1668
1720
  *
1669
1721
  * @type {ReportName}
@@ -1676,6 +1728,12 @@ export interface DeviceIntelligenceReport {
1676
1728
  * @memberof DeviceIntelligenceReport
1677
1729
  */
1678
1730
  'breakdown'?: DeviceIntelligenceBreakdown;
1731
+ /**
1732
+ *
1733
+ * @type {DeviceIntelligenceProperties}
1734
+ * @memberof DeviceIntelligenceReport
1735
+ */
1736
+ 'properties'?: DeviceIntelligenceProperties;
1679
1737
  }
1680
1738
  /**
1681
1739
  *
@@ -1688,7 +1746,7 @@ export interface Document {
1688
1746
  * @type {string}
1689
1747
  * @memberof Document
1690
1748
  */
1691
- 'file_type'?: DocumentFileTypeEnum;
1749
+ 'file_type'?: string;
1692
1750
  /**
1693
1751
  * The type of document
1694
1752
  * @type {DocumentTypes}
@@ -1750,14 +1808,6 @@ export interface Document {
1750
1808
  */
1751
1809
  'file_size'?: number;
1752
1810
  }
1753
- export declare const DocumentFileTypeEnum: {
1754
- readonly Jpg: "jpg";
1755
- readonly Jpeg: "jpeg";
1756
- readonly Png: "png";
1757
- readonly Pdf: "pdf";
1758
- readonly UnknownDefaultOpenApi: "11184809";
1759
- };
1760
- export type DocumentFileTypeEnum = typeof DocumentFileTypeEnum[keyof typeof DocumentFileTypeEnum];
1761
1811
  export declare const DocumentSideEnum: {
1762
1812
  readonly Front: "front";
1763
1813
  readonly Back: "back";
@@ -3034,10 +3084,10 @@ export interface DocumentProperties {
3034
3084
  'nfc'?: DocumentPropertiesNfc;
3035
3085
  /**
3036
3086
  *
3037
- * @type {DocumentPropertiesDrivingLicenceInformation}
3087
+ * @type {Array<DocumentPropertiesDrivingLicenceInformationItem>}
3038
3088
  * @memberof DocumentProperties
3039
3089
  */
3040
- 'driving_licence_information'?: DocumentPropertiesDrivingLicenceInformation;
3090
+ 'driving_licence_information'?: Array<DocumentPropertiesDrivingLicenceInformationItem>;
3041
3091
  /**
3042
3092
  *
3043
3093
  * @type {DocumentPropertiesDocumentClassification}
@@ -3283,31 +3333,31 @@ export interface DocumentPropertiesDocumentNumbersInner {
3283
3333
  /**
3284
3334
  *
3285
3335
  * @export
3286
- * @interface DocumentPropertiesDrivingLicenceInformation
3336
+ * @interface DocumentPropertiesDrivingLicenceInformationItem
3287
3337
  */
3288
- export interface DocumentPropertiesDrivingLicenceInformation {
3338
+ export interface DocumentPropertiesDrivingLicenceInformationItem {
3289
3339
  /**
3290
3340
  *
3291
3341
  * @type {string}
3292
- * @memberof DocumentPropertiesDrivingLicenceInformation
3342
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3293
3343
  */
3294
3344
  'category'?: string;
3295
3345
  /**
3296
3346
  *
3297
3347
  * @type {string}
3298
- * @memberof DocumentPropertiesDrivingLicenceInformation
3348
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3299
3349
  */
3300
3350
  'obtainment_date'?: string;
3301
3351
  /**
3302
3352
  *
3303
3353
  * @type {string}
3304
- * @memberof DocumentPropertiesDrivingLicenceInformation
3354
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3305
3355
  */
3306
3356
  'expiry_date'?: string;
3307
3357
  /**
3308
3358
  *
3309
3359
  * @type {string}
3310
- * @memberof DocumentPropertiesDrivingLicenceInformation
3360
+ * @memberof DocumentPropertiesDrivingLicenceInformationItem
3311
3361
  */
3312
3362
  'codes'?: string;
3313
3363
  }
@@ -3577,18 +3627,18 @@ export interface DocumentReport {
3577
3627
  * @memberof DocumentReport
3578
3628
  */
3579
3629
  'check_id'?: string;
3580
- /**
3581
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
3582
- * @type {Array<ReportDocument>}
3583
- * @memberof DocumentReport
3584
- */
3585
- 'documents'?: Array<ReportDocument>;
3586
3630
  /**
3587
3631
  *
3588
3632
  * @type {ReportName}
3589
3633
  * @memberof DocumentReport
3590
3634
  */
3591
3635
  'name': ReportName;
3636
+ /**
3637
+ * Array of objects with document ids that were used in the Onfido engine.
3638
+ * @type {Array<ReportDocument>}
3639
+ * @memberof DocumentReport
3640
+ */
3641
+ 'documents'?: Array<ReportDocument>;
3592
3642
  /**
3593
3643
  *
3594
3644
  * @type {DocumentBreakdown}
@@ -3602,6 +3652,19 @@ export interface DocumentReport {
3602
3652
  */
3603
3653
  'properties'?: DocumentProperties;
3604
3654
  }
3655
+ /**
3656
+ *
3657
+ * @export
3658
+ * @interface DocumentReportShared
3659
+ */
3660
+ export interface DocumentReportShared {
3661
+ /**
3662
+ * Array of objects with document ids that were used in the Onfido engine.
3663
+ * @type {Array<ReportDocument>}
3664
+ * @memberof DocumentReportShared
3665
+ */
3666
+ 'documents'?: Array<ReportDocument>;
3667
+ }
3605
3668
  /**
3606
3669
  *
3607
3670
  * @export
@@ -3656,7 +3719,7 @@ export interface DocumentShared {
3656
3719
  * @type {string}
3657
3720
  * @memberof DocumentShared
3658
3721
  */
3659
- 'file_type'?: DocumentSharedFileTypeEnum;
3722
+ 'file_type'?: string;
3660
3723
  /**
3661
3724
  * The type of document
3662
3725
  * @type {DocumentTypes}
@@ -3682,14 +3745,6 @@ export interface DocumentShared {
3682
3745
  */
3683
3746
  'applicant_id'?: string;
3684
3747
  }
3685
- export declare const DocumentSharedFileTypeEnum: {
3686
- readonly Jpg: "jpg";
3687
- readonly Jpeg: "jpeg";
3688
- readonly Png: "png";
3689
- readonly Pdf: "pdf";
3690
- readonly UnknownDefaultOpenApi: "11184809";
3691
- };
3692
- export type DocumentSharedFileTypeEnum = typeof DocumentSharedFileTypeEnum[keyof typeof DocumentSharedFileTypeEnum];
3693
3748
  export declare const DocumentSharedSideEnum: {
3694
3749
  readonly Front: "front";
3695
3750
  readonly Back: "back";
@@ -3829,18 +3884,18 @@ export interface DocumentVideoReport {
3829
3884
  * @memberof DocumentVideoReport
3830
3885
  */
3831
3886
  'check_id'?: string;
3832
- /**
3833
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
3834
- * @type {Array<ReportDocument>}
3835
- * @memberof DocumentVideoReport
3836
- */
3837
- 'documents'?: Array<ReportDocument>;
3838
3887
  /**
3839
3888
  *
3840
3889
  * @type {ReportName}
3841
3890
  * @memberof DocumentVideoReport
3842
3891
  */
3843
3892
  'name': ReportName;
3893
+ /**
3894
+ * Array of objects with document ids that were used in the Onfido engine.
3895
+ * @type {Array<ReportDocument>}
3896
+ * @memberof DocumentVideoReport
3897
+ */
3898
+ 'documents'?: Array<ReportDocument>;
3844
3899
  /**
3845
3900
  *
3846
3901
  * @type {DocumentBreakdown}
@@ -3902,18 +3957,18 @@ export interface DocumentVideoWithAddressInformationReport {
3902
3957
  * @memberof DocumentVideoWithAddressInformationReport
3903
3958
  */
3904
3959
  'check_id'?: string;
3905
- /**
3906
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
3907
- * @type {Array<ReportDocument>}
3908
- * @memberof DocumentVideoWithAddressInformationReport
3909
- */
3910
- 'documents'?: Array<ReportDocument>;
3911
3960
  /**
3912
3961
  *
3913
3962
  * @type {ReportName}
3914
3963
  * @memberof DocumentVideoWithAddressInformationReport
3915
3964
  */
3916
3965
  'name': ReportName;
3966
+ /**
3967
+ * Array of objects with document ids that were used in the Onfido engine.
3968
+ * @type {Array<ReportDocument>}
3969
+ * @memberof DocumentVideoWithAddressInformationReport
3970
+ */
3971
+ 'documents'?: Array<ReportDocument>;
3917
3972
  /**
3918
3973
  *
3919
3974
  * @type {DocumentBreakdown}
@@ -3975,18 +4030,18 @@ export interface DocumentWithAddressInformationReport {
3975
4030
  * @memberof DocumentWithAddressInformationReport
3976
4031
  */
3977
4032
  'check_id'?: string;
3978
- /**
3979
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
3980
- * @type {Array<ReportDocument>}
3981
- * @memberof DocumentWithAddressInformationReport
3982
- */
3983
- 'documents'?: Array<ReportDocument>;
3984
4033
  /**
3985
4034
  *
3986
4035
  * @type {ReportName}
3987
4036
  * @memberof DocumentWithAddressInformationReport
3988
4037
  */
3989
4038
  'name': ReportName;
4039
+ /**
4040
+ * Array of objects with document ids that were used in the Onfido engine.
4041
+ * @type {Array<ReportDocument>}
4042
+ * @memberof DocumentWithAddressInformationReport
4043
+ */
4044
+ 'documents'?: Array<ReportDocument>;
3990
4045
  /**
3991
4046
  *
3992
4047
  * @type {DocumentBreakdown}
@@ -4048,18 +4103,18 @@ export interface DocumentWithDriverVerificationReport {
4048
4103
  * @memberof DocumentWithDriverVerificationReport
4049
4104
  */
4050
4105
  'check_id'?: string;
4051
- /**
4052
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
4053
- * @type {Array<ReportDocument>}
4054
- * @memberof DocumentWithDriverVerificationReport
4055
- */
4056
- 'documents'?: Array<ReportDocument>;
4057
4106
  /**
4058
4107
  *
4059
4108
  * @type {ReportName}
4060
4109
  * @memberof DocumentWithDriverVerificationReport
4061
4110
  */
4062
4111
  'name': ReportName;
4112
+ /**
4113
+ * Array of objects with document ids that were used in the Onfido engine.
4114
+ * @type {Array<ReportDocument>}
4115
+ * @memberof DocumentWithDriverVerificationReport
4116
+ */
4117
+ 'documents'?: Array<ReportDocument>;
4063
4118
  /**
4064
4119
  *
4065
4120
  * @type {DocumentBreakdown}
@@ -4333,10 +4388,10 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4333
4388
  'nfc'?: DocumentPropertiesNfc;
4334
4389
  /**
4335
4390
  *
4336
- * @type {DocumentPropertiesDrivingLicenceInformation}
4391
+ * @type {Array<DocumentPropertiesDrivingLicenceInformationItem>}
4337
4392
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4338
4393
  */
4339
- 'driving_licence_information'?: DocumentPropertiesDrivingLicenceInformation;
4394
+ 'driving_licence_information'?: Array<DocumentPropertiesDrivingLicenceInformationItem>;
4340
4395
  /**
4341
4396
  *
4342
4397
  * @type {DocumentPropertiesDocumentClassification}
@@ -4517,18 +4572,18 @@ export interface DocumentWithDrivingLicenceInformationReport {
4517
4572
  * @memberof DocumentWithDrivingLicenceInformationReport
4518
4573
  */
4519
4574
  'check_id'?: string;
4520
- /**
4521
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
4522
- * @type {Array<ReportDocument>}
4523
- * @memberof DocumentWithDrivingLicenceInformationReport
4524
- */
4525
- 'documents'?: Array<ReportDocument>;
4526
4575
  /**
4527
4576
  *
4528
4577
  * @type {ReportName}
4529
4578
  * @memberof DocumentWithDrivingLicenceInformationReport
4530
4579
  */
4531
4580
  'name': ReportName;
4581
+ /**
4582
+ * Array of objects with document ids that were used in the Onfido engine.
4583
+ * @type {Array<ReportDocument>}
4584
+ * @memberof DocumentWithDrivingLicenceInformationReport
4585
+ */
4586
+ 'documents'?: Array<ReportDocument>;
4532
4587
  /**
4533
4588
  *
4534
4589
  * @type {DocumentBreakdown}
@@ -5115,18 +5170,18 @@ export interface FacialSimilarityMotionReport {
5115
5170
  * @memberof FacialSimilarityMotionReport
5116
5171
  */
5117
5172
  'check_id'?: string;
5118
- /**
5119
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
5120
- * @type {Array<ReportDocument>}
5121
- * @memberof FacialSimilarityMotionReport
5122
- */
5123
- 'documents'?: Array<ReportDocument>;
5124
5173
  /**
5125
5174
  *
5126
5175
  * @type {ReportName}
5127
5176
  * @memberof FacialSimilarityMotionReport
5128
5177
  */
5129
5178
  'name': ReportName;
5179
+ /**
5180
+ * Array of objects with document ids that were used in the Onfido engine.
5181
+ * @type {Array<ReportDocument>}
5182
+ * @memberof FacialSimilarityMotionReport
5183
+ */
5184
+ 'documents'?: Array<ReportDocument>;
5130
5185
  /**
5131
5186
  * Array of objects with live photo ids that were used in the Onfido engine.
5132
5187
  * @type {Array<FacialSimilarityReportMedia>}
@@ -5542,18 +5597,18 @@ export interface FacialSimilarityPhotoFullyAutoReport {
5542
5597
  * @memberof FacialSimilarityPhotoFullyAutoReport
5543
5598
  */
5544
5599
  'check_id'?: string;
5545
- /**
5546
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
5547
- * @type {Array<ReportDocument>}
5548
- * @memberof FacialSimilarityPhotoFullyAutoReport
5549
- */
5550
- 'documents'?: Array<ReportDocument>;
5551
5600
  /**
5552
5601
  *
5553
5602
  * @type {ReportName}
5554
5603
  * @memberof FacialSimilarityPhotoFullyAutoReport
5555
5604
  */
5556
5605
  'name': ReportName;
5606
+ /**
5607
+ * Array of objects with document ids that were used in the Onfido engine.
5608
+ * @type {Array<ReportDocument>}
5609
+ * @memberof FacialSimilarityPhotoFullyAutoReport
5610
+ */
5611
+ 'documents'?: Array<ReportDocument>;
5557
5612
  /**
5558
5613
  * Array of objects with live photo ids that were used in the Onfido engine.
5559
5614
  * @type {Array<FacialSimilarityReportMedia>}
@@ -5652,18 +5707,18 @@ export interface FacialSimilarityPhotoReport {
5652
5707
  * @memberof FacialSimilarityPhotoReport
5653
5708
  */
5654
5709
  'check_id'?: string;
5655
- /**
5656
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
5657
- * @type {Array<ReportDocument>}
5658
- * @memberof FacialSimilarityPhotoReport
5659
- */
5660
- 'documents'?: Array<ReportDocument>;
5661
5710
  /**
5662
5711
  *
5663
5712
  * @type {ReportName}
5664
5713
  * @memberof FacialSimilarityPhotoReport
5665
5714
  */
5666
5715
  'name': ReportName;
5716
+ /**
5717
+ * Array of objects with document ids that were used in the Onfido engine.
5718
+ * @type {Array<ReportDocument>}
5719
+ * @memberof FacialSimilarityPhotoReport
5720
+ */
5721
+ 'documents'?: Array<ReportDocument>;
5667
5722
  /**
5668
5723
  * Array of objects with live photo ids that were used in the Onfido engine.
5669
5724
  * @type {Array<FacialSimilarityReportMedia>}
@@ -5720,6 +5775,12 @@ export interface FacialSimilarityReportMedia {
5720
5775
  * @interface FacialSimilarityReportShared
5721
5776
  */
5722
5777
  export interface FacialSimilarityReportShared {
5778
+ /**
5779
+ * Array of objects with document ids that were used in the Onfido engine.
5780
+ * @type {Array<ReportDocument>}
5781
+ * @memberof FacialSimilarityReportShared
5782
+ */
5783
+ 'documents'?: Array<ReportDocument>;
5723
5784
  /**
5724
5785
  * Array of objects with live photo ids that were used in the Onfido engine.
5725
5786
  * @type {Array<FacialSimilarityReportMedia>}
@@ -6002,18 +6063,18 @@ export interface FacialSimilarityVideoReport {
6002
6063
  * @memberof FacialSimilarityVideoReport
6003
6064
  */
6004
6065
  'check_id'?: string;
6005
- /**
6006
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
6007
- * @type {Array<ReportDocument>}
6008
- * @memberof FacialSimilarityVideoReport
6009
- */
6010
- 'documents'?: Array<ReportDocument>;
6011
6066
  /**
6012
6067
  *
6013
6068
  * @type {ReportName}
6014
6069
  * @memberof FacialSimilarityVideoReport
6015
6070
  */
6016
6071
  'name': ReportName;
6072
+ /**
6073
+ * Array of objects with document ids that were used in the Onfido engine.
6074
+ * @type {Array<ReportDocument>}
6075
+ * @memberof FacialSimilarityVideoReport
6076
+ */
6077
+ 'documents'?: Array<ReportDocument>;
6017
6078
  /**
6018
6079
  * Array of objects with live photo ids that were used in the Onfido engine.
6019
6080
  * @type {Array<FacialSimilarityReportMedia>}
@@ -6585,12 +6646,6 @@ export interface IdentityEnhancedReport {
6585
6646
  * @memberof IdentityEnhancedReport
6586
6647
  */
6587
6648
  'check_id'?: string;
6588
- /**
6589
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
6590
- * @type {Array<ReportDocument>}
6591
- * @memberof IdentityEnhancedReport
6592
- */
6593
- 'documents'?: Array<ReportDocument>;
6594
6649
  /**
6595
6650
  *
6596
6651
  * @type {ReportName}
@@ -6658,12 +6713,6 @@ export interface IndiaPanReport {
6658
6713
  * @memberof IndiaPanReport
6659
6714
  */
6660
6715
  'check_id'?: string;
6661
- /**
6662
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
6663
- * @type {Array<ReportDocument>}
6664
- * @memberof IndiaPanReport
6665
- */
6666
- 'documents'?: Array<ReportDocument>;
6667
6716
  /**
6668
6717
  *
6669
6718
  * @type {ReportName}
@@ -6916,12 +6965,6 @@ export interface KnownFacesReport {
6916
6965
  * @memberof KnownFacesReport
6917
6966
  */
6918
6967
  'check_id'?: string;
6919
- /**
6920
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
6921
- * @type {Array<ReportDocument>}
6922
- * @memberof KnownFacesReport
6923
- */
6924
- 'documents'?: Array<ReportDocument>;
6925
6968
  /**
6926
6969
  *
6927
6970
  * @type {ReportName}
@@ -7579,12 +7622,6 @@ export interface ProofOfAddressReport {
7579
7622
  * @memberof ProofOfAddressReport
7580
7623
  */
7581
7624
  'check_id'?: string;
7582
- /**
7583
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
7584
- * @type {Array<ReportDocument>}
7585
- * @memberof ProofOfAddressReport
7586
- */
7587
- 'documents'?: Array<ReportDocument>;
7588
7625
  /**
7589
7626
  *
7590
7627
  * @type {ReportName}
@@ -7858,12 +7895,6 @@ export interface ReportShared {
7858
7895
  * @memberof ReportShared
7859
7896
  */
7860
7897
  'check_id'?: string;
7861
- /**
7862
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
7863
- * @type {Array<ReportDocument>}
7864
- * @memberof ReportShared
7865
- */
7866
- 'documents'?: Array<ReportDocument>;
7867
7898
  /**
7868
7899
  *
7869
7900
  * @type {ReportName}
@@ -8583,12 +8614,6 @@ export interface UsDrivingLicenceReport {
8583
8614
  * @memberof UsDrivingLicenceReport
8584
8615
  */
8585
8616
  'check_id'?: string;
8586
- /**
8587
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
8588
- * @type {Array<ReportDocument>}
8589
- * @memberof UsDrivingLicenceReport
8590
- */
8591
- 'documents'?: Array<ReportDocument>;
8592
8617
  /**
8593
8618
  *
8594
8619
  * @type {ReportName}
@@ -8871,11 +8896,11 @@ export interface WatchlistAmlBreakdownSanction {
8871
8896
  export interface WatchlistAmlProperties {
8872
8897
  /**
8873
8898
  * Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
8874
- * @type {Array<string>}
8899
+ * @type {Array<object>}
8875
8900
  * @memberof WatchlistAmlProperties
8876
8901
  * @deprecated
8877
8902
  */
8878
- 'records'?: Array<string>;
8903
+ 'records'?: Array<object>;
8879
8904
  }
8880
8905
  /**
8881
8906
  *
@@ -8925,12 +8950,6 @@ export interface WatchlistAmlReport {
8925
8950
  * @memberof WatchlistAmlReport
8926
8951
  */
8927
8952
  'check_id'?: string;
8928
- /**
8929
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
8930
- * @type {Array<ReportDocument>}
8931
- * @memberof WatchlistAmlReport
8932
- */
8933
- 'documents'?: Array<ReportDocument>;
8934
8953
  /**
8935
8954
  *
8936
8955
  * @type {ReportName}
@@ -9308,12 +9327,6 @@ export interface WatchlistEnhancedReport {
9308
9327
  * @memberof WatchlistEnhancedReport
9309
9328
  */
9310
9329
  'check_id'?: string;
9311
- /**
9312
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
9313
- * @type {Array<ReportDocument>}
9314
- * @memberof WatchlistEnhancedReport
9315
- */
9316
- 'documents'?: Array<ReportDocument>;
9317
9330
  /**
9318
9331
  *
9319
9332
  * @type {ReportName}
@@ -9593,12 +9606,6 @@ export interface WatchlistPepsOnlyReport {
9593
9606
  * @memberof WatchlistPepsOnlyReport
9594
9607
  */
9595
9608
  'check_id'?: string;
9596
- /**
9597
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
9598
- * @type {Array<ReportDocument>}
9599
- * @memberof WatchlistPepsOnlyReport
9600
- */
9601
- 'documents'?: Array<ReportDocument>;
9602
9609
  /**
9603
9610
  *
9604
9611
  * @type {ReportName}
@@ -9666,12 +9673,6 @@ export interface WatchlistSanctionsOnlyReport {
9666
9673
  * @memberof WatchlistSanctionsOnlyReport
9667
9674
  */
9668
9675
  'check_id'?: string;
9669
- /**
9670
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
9671
- * @type {Array<ReportDocument>}
9672
- * @memberof WatchlistSanctionsOnlyReport
9673
- */
9674
- 'documents'?: Array<ReportDocument>;
9675
9676
  /**
9676
9677
  *
9677
9678
  * @type {ReportName}
@@ -9724,11 +9725,11 @@ export interface WatchlistStandardBreakdown {
9724
9725
  export interface WatchlistStandardProperties {
9725
9726
  /**
9726
9727
  * Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
9727
- * @type {Array<string>}
9728
+ * @type {Array<object>}
9728
9729
  * @memberof WatchlistStandardProperties
9729
9730
  * @deprecated
9730
9731
  */
9731
- 'records'?: Array<string>;
9732
+ 'records'?: Array<object>;
9732
9733
  }
9733
9734
  /**
9734
9735
  *
@@ -9778,12 +9779,6 @@ export interface WatchlistStandardReport {
9778
9779
  * @memberof WatchlistStandardReport
9779
9780
  */
9780
9781
  'check_id'?: string;
9781
- /**
9782
- * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
9783
- * @type {Array<ReportDocument>}
9784
- * @memberof WatchlistStandardReport
9785
- */
9786
- 'documents'?: Array<ReportDocument>;
9787
9782
  /**
9788
9783
  *
9789
9784
  * @type {ReportName}
@@ -9833,6 +9828,36 @@ export interface Webhook {
9833
9828
  * @memberof Webhook
9834
9829
  */
9835
9830
  'payload_version'?: number;
9831
+ /**
9832
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
9833
+ * @type {boolean}
9834
+ * @memberof Webhook
9835
+ */
9836
+ 'oauth_enabled'?: boolean;
9837
+ /**
9838
+ * The url to fetch the OAuth access token using client credentials grant.
9839
+ * @type {string}
9840
+ * @memberof Webhook
9841
+ */
9842
+ 'oauth_server_url'?: string;
9843
+ /**
9844
+ * The client id to authenticate the client credentials grant.
9845
+ * @type {string}
9846
+ * @memberof Webhook
9847
+ */
9848
+ 'oauth_server_client_id'?: string;
9849
+ /**
9850
+ * The client secret to authenticate the client credentials grant.
9851
+ * @type {string}
9852
+ * @memberof Webhook
9853
+ */
9854
+ 'oauth_server_client_secret'?: string;
9855
+ /**
9856
+ * The scopes to be sent when requesting the access token.
9857
+ * @type {string}
9858
+ * @memberof Webhook
9859
+ */
9860
+ 'oauth_server_scope'?: string;
9836
9861
  /**
9837
9862
  * The unique identifier of the webhook.
9838
9863
  * @type {string}
@@ -9888,6 +9913,36 @@ export interface WebhookBuilder {
9888
9913
  * @memberof WebhookBuilder
9889
9914
  */
9890
9915
  'payload_version'?: number;
9916
+ /**
9917
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
9918
+ * @type {boolean}
9919
+ * @memberof WebhookBuilder
9920
+ */
9921
+ 'oauth_enabled'?: boolean;
9922
+ /**
9923
+ * The url to fetch the OAuth access token using client credentials grant.
9924
+ * @type {string}
9925
+ * @memberof WebhookBuilder
9926
+ */
9927
+ 'oauth_server_url'?: string;
9928
+ /**
9929
+ * The client id to authenticate the client credentials grant.
9930
+ * @type {string}
9931
+ * @memberof WebhookBuilder
9932
+ */
9933
+ 'oauth_server_client_id'?: string;
9934
+ /**
9935
+ * The client secret to authenticate the client credentials grant.
9936
+ * @type {string}
9937
+ * @memberof WebhookBuilder
9938
+ */
9939
+ 'oauth_server_client_secret'?: string;
9940
+ /**
9941
+ * The scopes to be sent when requesting the access token.
9942
+ * @type {string}
9943
+ * @memberof WebhookBuilder
9944
+ */
9945
+ 'oauth_server_scope'?: string;
9891
9946
  /**
9892
9947
  * The url that will listen to notifications (must be https).
9893
9948
  * @type {string}
@@ -10015,7 +10070,7 @@ export interface WebhookEventPayloadObject {
10015
10070
  * @type {string}
10016
10071
  * @memberof WebhookEventPayloadObject
10017
10072
  */
10018
- 'href': string;
10073
+ 'href'?: string;
10019
10074
  }
10020
10075
  /**
10021
10076
  * The resource affected by this event.
@@ -10159,7 +10214,6 @@ export declare const WebhookEventType: {
10159
10214
  readonly ReportAwaitingApproval: "report.awaiting_approval";
10160
10215
  readonly ReportCompleted: "report.completed";
10161
10216
  readonly WorkflowTimelineFileCreated: "workflow_timeline_file.created";
10162
- readonly WorkflowSignedEvidenceFileCreated: "workflow_signed_evidence_file.created";
10163
10217
  readonly WorkflowRunEvidenceFolderCreated: "workflow_run_evidence_folder.created";
10164
10218
  readonly UnknownDefaultOpenApi: "11184809";
10165
10219
  };
@@ -10238,6 +10292,36 @@ export interface WebhookShared {
10238
10292
  * @memberof WebhookShared
10239
10293
  */
10240
10294
  'payload_version'?: number;
10295
+ /**
10296
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
10297
+ * @type {boolean}
10298
+ * @memberof WebhookShared
10299
+ */
10300
+ 'oauth_enabled'?: boolean;
10301
+ /**
10302
+ * The url to fetch the OAuth access token using client credentials grant.
10303
+ * @type {string}
10304
+ * @memberof WebhookShared
10305
+ */
10306
+ 'oauth_server_url'?: string;
10307
+ /**
10308
+ * The client id to authenticate the client credentials grant.
10309
+ * @type {string}
10310
+ * @memberof WebhookShared
10311
+ */
10312
+ 'oauth_server_client_id'?: string;
10313
+ /**
10314
+ * The client secret to authenticate the client credentials grant.
10315
+ * @type {string}
10316
+ * @memberof WebhookShared
10317
+ */
10318
+ 'oauth_server_client_secret'?: string;
10319
+ /**
10320
+ * The scopes to be sent when requesting the access token.
10321
+ * @type {string}
10322
+ * @memberof WebhookShared
10323
+ */
10324
+ 'oauth_server_scope'?: string;
10241
10325
  }
10242
10326
  /**
10243
10327
  *
@@ -10282,6 +10366,36 @@ export interface WebhookUpdater {
10282
10366
  * @memberof WebhookUpdater
10283
10367
  */
10284
10368
  'payload_version'?: number;
10369
+ /**
10370
+ * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
10371
+ * @type {boolean}
10372
+ * @memberof WebhookUpdater
10373
+ */
10374
+ 'oauth_enabled'?: boolean;
10375
+ /**
10376
+ * The url to fetch the OAuth access token using client credentials grant.
10377
+ * @type {string}
10378
+ * @memberof WebhookUpdater
10379
+ */
10380
+ 'oauth_server_url'?: string;
10381
+ /**
10382
+ * The client id to authenticate the client credentials grant.
10383
+ * @type {string}
10384
+ * @memberof WebhookUpdater
10385
+ */
10386
+ 'oauth_server_client_id'?: string;
10387
+ /**
10388
+ * The client secret to authenticate the client credentials grant.
10389
+ * @type {string}
10390
+ * @memberof WebhookUpdater
10391
+ */
10392
+ 'oauth_server_client_secret'?: string;
10393
+ /**
10394
+ * The scopes to be sent when requesting the access token.
10395
+ * @type {string}
10396
+ * @memberof WebhookUpdater
10397
+ */
10398
+ 'oauth_server_scope'?: string;
10285
10399
  /**
10286
10400
  * The url that will listen to notifications (must be https).
10287
10401
  * @type {string}
@@ -10853,6 +10967,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
10853
10967
  * @throws {RequiredError}
10854
10968
  */
10855
10969
  downloadMotionCaptureFrame: (motionCaptureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10970
+ /**
10971
+ * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
10972
+ * @summary Download NFC face
10973
+ * @param {string} documentId
10974
+ * @param {*} [options] Override http request option.
10975
+ * @throws {RequiredError}
10976
+ */
10977
+ downloadNfcFace: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10856
10978
  /**
10857
10979
  * Retrieves the signed document or application form depending on the file_id provided.
10858
10980
  * @summary Retrieves the signed document or application form
@@ -10894,6 +11016,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
10894
11016
  * @throws {RequiredError}
10895
11017
  */
10896
11018
  findApplicant: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11019
+ /**
11020
+ * Retrieves consents for single applicant.
11021
+ * @summary Retrieve Applicant Consents
11022
+ * @param {string} applicantId
11023
+ * @param {*} [options] Override http request option.
11024
+ * @throws {RequiredError}
11025
+ */
11026
+ findApplicantConsents: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10897
11027
  /**
10898
11028
  * Retrieves a single check. Returns a check object.
10899
11029
  * @summary Retrieve a Check
@@ -11122,10 +11252,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11122
11252
  * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
11123
11253
  * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
11124
11254
  * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
11255
+ * @param {string} [applicantId] the applicant\&#39;s id.
11125
11256
  * @param {*} [options] Override http request option.
11126
11257
  * @throws {RequiredError}
11127
11258
  */
11128
- listWorkflowRuns: (page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11259
+ listWorkflowRuns: (page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11129
11260
  /**
11130
11261
  * Run a health check on the Onfido API
11131
11262
  * @summary Ping
@@ -11206,7 +11337,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11206
11337
  * @param {DocumentTypes} type The type of document
11207
11338
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
11208
11339
  * @param {FileTransfer} file The file to be uploaded.
11209
- * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
11340
+ * @param {string} [fileType] The file type of the uploaded file
11210
11341
  * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
11211
11342
  * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
11212
11343
  * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -11214,7 +11345,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11214
11345
  * @param {*} [options] Override http request option.
11215
11346
  * @throws {RequiredError}
11216
11347
  */
11217
- uploadDocument: (type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11348
+ uploadDocument: (type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11218
11349
  /**
11219
11350
  * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
11220
11351
  * @summary Upload ID photo
@@ -11410,6 +11541,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11410
11541
  * @throws {RequiredError}
11411
11542
  */
11412
11543
  downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
11544
+ /**
11545
+ * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
11546
+ * @summary Download NFC face
11547
+ * @param {string} documentId
11548
+ * @param {*} [options] Override http request option.
11549
+ * @throws {RequiredError}
11550
+ */
11551
+ downloadNfcFace(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
11413
11552
  /**
11414
11553
  * Retrieves the signed document or application form depending on the file_id provided.
11415
11554
  * @summary Retrieves the signed document or application form
@@ -11451,6 +11590,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11451
11590
  * @throws {RequiredError}
11452
11591
  */
11453
11592
  findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Applicant>>;
11593
+ /**
11594
+ * Retrieves consents for single applicant.
11595
+ * @summary Retrieve Applicant Consents
11596
+ * @param {string} applicantId
11597
+ * @param {*} [options] Override http request option.
11598
+ * @throws {RequiredError}
11599
+ */
11600
+ findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicantConsent>>>;
11454
11601
  /**
11455
11602
  * Retrieves a single check. Returns a check object.
11456
11603
  * @summary Retrieve a Check
@@ -11679,10 +11826,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11679
11826
  * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
11680
11827
  * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
11681
11828
  * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
11829
+ * @param {string} [applicantId] the applicant\&#39;s id.
11682
11830
  * @param {*} [options] Override http request option.
11683
11831
  * @throws {RequiredError}
11684
11832
  */
11685
- listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowRun>>>;
11833
+ listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowRun>>>;
11686
11834
  /**
11687
11835
  * Run a health check on the Onfido API
11688
11836
  * @summary Ping
@@ -11763,7 +11911,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11763
11911
  * @param {DocumentTypes} type The type of document
11764
11912
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
11765
11913
  * @param {FileTransfer} file The file to be uploaded.
11766
- * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
11914
+ * @param {string} [fileType] The file type of the uploaded file
11767
11915
  * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
11768
11916
  * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
11769
11917
  * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -11771,7 +11919,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11771
11919
  * @param {*} [options] Override http request option.
11772
11920
  * @throws {RequiredError}
11773
11921
  */
11774
- uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Document>>;
11922
+ uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Document>>;
11775
11923
  /**
11776
11924
  * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
11777
11925
  * @summary Upload ID photo
@@ -11967,6 +12115,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
11967
12115
  * @throws {RequiredError}
11968
12116
  */
11969
12117
  downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
12118
+ /**
12119
+ * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
12120
+ * @summary Download NFC face
12121
+ * @param {string} documentId
12122
+ * @param {*} [options] Override http request option.
12123
+ * @throws {RequiredError}
12124
+ */
12125
+ downloadNfcFace(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
11970
12126
  /**
11971
12127
  * Retrieves the signed document or application form depending on the file_id provided.
11972
12128
  * @summary Retrieves the signed document or application form
@@ -12008,6 +12164,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12008
12164
  * @throws {RequiredError}
12009
12165
  */
12010
12166
  findApplicant(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<Applicant>;
12167
+ /**
12168
+ * Retrieves consents for single applicant.
12169
+ * @summary Retrieve Applicant Consents
12170
+ * @param {string} applicantId
12171
+ * @param {*} [options] Override http request option.
12172
+ * @throws {RequiredError}
12173
+ */
12174
+ findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicantConsent>>;
12011
12175
  /**
12012
12176
  * Retrieves a single check. Returns a check object.
12013
12177
  * @summary Retrieve a Check
@@ -12236,10 +12400,11 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12236
12400
  * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
12237
12401
  * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
12238
12402
  * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
12403
+ * @param {string} [applicantId] the applicant\&#39;s id.
12239
12404
  * @param {*} [options] Override http request option.
12240
12405
  * @throws {RequiredError}
12241
12406
  */
12242
- listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowRun>>;
12407
+ listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowRun>>;
12243
12408
  /**
12244
12409
  * Run a health check on the Onfido API
12245
12410
  * @summary Ping
@@ -12320,7 +12485,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12320
12485
  * @param {DocumentTypes} type The type of document
12321
12486
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
12322
12487
  * @param {FileTransfer} file The file to be uploaded.
12323
- * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
12488
+ * @param {string} [fileType] The file type of the uploaded file
12324
12489
  * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
12325
12490
  * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
12326
12491
  * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -12328,7 +12493,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12328
12493
  * @param {*} [options] Override http request option.
12329
12494
  * @throws {RequiredError}
12330
12495
  */
12331
- uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Document>;
12496
+ uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Document>;
12332
12497
  /**
12333
12498
  * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
12334
12499
  * @summary Upload ID photo
@@ -12547,6 +12712,15 @@ export declare class DefaultApi extends BaseAPI {
12547
12712
  * @memberof DefaultApi
12548
12713
  */
12549
12714
  downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
12715
+ /**
12716
+ * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
12717
+ * @summary Download NFC face
12718
+ * @param {string} documentId
12719
+ * @param {*} [options] Override http request option.
12720
+ * @throws {RequiredError}
12721
+ * @memberof DefaultApi
12722
+ */
12723
+ downloadNfcFace(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
12550
12724
  /**
12551
12725
  * Retrieves the signed document or application form depending on the file_id provided.
12552
12726
  * @summary Retrieves the signed document or application form
@@ -12593,6 +12767,15 @@ export declare class DefaultApi extends BaseAPI {
12593
12767
  * @memberof DefaultApi
12594
12768
  */
12595
12769
  findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any>>;
12770
+ /**
12771
+ * Retrieves consents for single applicant.
12772
+ * @summary Retrieve Applicant Consents
12773
+ * @param {string} applicantId
12774
+ * @param {*} [options] Override http request option.
12775
+ * @throws {RequiredError}
12776
+ * @memberof DefaultApi
12777
+ */
12778
+ findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantConsent[], any>>;
12596
12779
  /**
12597
12780
  * Retrieves a single check. Returns a check object.
12598
12781
  * @summary Retrieve a Check
@@ -12848,11 +13031,12 @@ export declare class DefaultApi extends BaseAPI {
12848
13031
  * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
12849
13032
  * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
12850
13033
  * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
13034
+ * @param {string} [applicantId] the applicant\&#39;s id.
12851
13035
  * @param {*} [options] Override http request option.
12852
13036
  * @throws {RequiredError}
12853
13037
  * @memberof DefaultApi
12854
13038
  */
12855
- listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun[], any>>;
13039
+ listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun[], any>>;
12856
13040
  /**
12857
13041
  * Run a health check on the Onfido API
12858
13042
  * @summary Ping
@@ -12942,7 +13126,7 @@ export declare class DefaultApi extends BaseAPI {
12942
13126
  * @param {DocumentTypes} type The type of document
12943
13127
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
12944
13128
  * @param {FileTransfer} file The file to be uploaded.
12945
- * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
13129
+ * @param {string} [fileType] The file type of the uploaded file
12946
13130
  * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
12947
13131
  * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
12948
13132
  * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -12951,7 +13135,7 @@ export declare class DefaultApi extends BaseAPI {
12951
13135
  * @throws {RequiredError}
12952
13136
  * @memberof DefaultApi
12953
13137
  */
12954
- uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any>>;
13138
+ uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any>>;
12955
13139
  /**
12956
13140
  * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
12957
13141
  * @summary Upload ID photo
@@ -12983,17 +13167,6 @@ export declare const ListWorkflowRunsSortEnum: {
12983
13167
  readonly UnknownDefaultOpenApi: "11184809";
12984
13168
  };
12985
13169
  export type ListWorkflowRunsSortEnum = typeof ListWorkflowRunsSortEnum[keyof typeof ListWorkflowRunsSortEnum];
12986
- /**
12987
- * @export
12988
- */
12989
- export declare const UploadDocumentFileTypeEnum: {
12990
- readonly Jpg: "jpg";
12991
- readonly Jpeg: "jpeg";
12992
- readonly Png: "png";
12993
- readonly Pdf: "pdf";
12994
- readonly UnknownDefaultOpenApi: "11184809";
12995
- };
12996
- export type UploadDocumentFileTypeEnum = typeof UploadDocumentFileTypeEnum[keyof typeof UploadDocumentFileTypeEnum];
12997
13170
  /**
12998
13171
  * @export
12999
13172
  */