@onfido/api 3.5.0 → 4.0.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/README.md +1 -1
- package/dist/api.d.ts +780 -374
- package/dist/api.js +88 -45
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +780 -374
- package/dist/esm/api.js +87 -44
- package/dist/esm/configuration.js +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -380,11 +380,11 @@ export interface ApplicantBuilder {
|
|
|
380
380
|
*/
|
|
381
381
|
'phone_number'?: string;
|
|
382
382
|
/**
|
|
383
|
-
*
|
|
384
|
-
* @type {
|
|
383
|
+
* The applicant\'s consents
|
|
384
|
+
* @type {Array<ApplicantConsentBuilder>}
|
|
385
385
|
* @memberof ApplicantBuilder
|
|
386
386
|
*/
|
|
387
|
-
'consents'?:
|
|
387
|
+
'consents'?: Array<ApplicantConsentBuilder>;
|
|
388
388
|
/**
|
|
389
389
|
*
|
|
390
390
|
* @type {AddressBuilder}
|
|
@@ -410,6 +410,37 @@ export interface ApplicantBuilder {
|
|
|
410
410
|
*/
|
|
411
411
|
'last_name': string;
|
|
412
412
|
}
|
|
413
|
+
/**
|
|
414
|
+
*
|
|
415
|
+
* @export
|
|
416
|
+
* @interface ApplicantConsentBuilder
|
|
417
|
+
*/
|
|
418
|
+
export interface ApplicantConsentBuilder {
|
|
419
|
+
/**
|
|
420
|
+
*
|
|
421
|
+
* @type {ApplicantConsentName}
|
|
422
|
+
* @memberof ApplicantConsentBuilder
|
|
423
|
+
*/
|
|
424
|
+
'name': ApplicantConsentName;
|
|
425
|
+
/**
|
|
426
|
+
*
|
|
427
|
+
* @type {boolean}
|
|
428
|
+
* @memberof ApplicantConsentBuilder
|
|
429
|
+
*/
|
|
430
|
+
'granted': boolean;
|
|
431
|
+
}
|
|
432
|
+
/**
|
|
433
|
+
*
|
|
434
|
+
* @export
|
|
435
|
+
* @enum {string}
|
|
436
|
+
*/
|
|
437
|
+
export declare const ApplicantConsentName: {
|
|
438
|
+
readonly PrivacyNoticesRead: "privacy_notices_read";
|
|
439
|
+
readonly SsnVerification: "ssn_verification";
|
|
440
|
+
readonly PhoneNumberVerification: "phone_number_verification";
|
|
441
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
442
|
+
};
|
|
443
|
+
export type ApplicantConsentName = typeof ApplicantConsentName[keyof typeof ApplicantConsentName];
|
|
413
444
|
/**
|
|
414
445
|
*
|
|
415
446
|
* @export
|
|
@@ -436,11 +467,11 @@ export interface ApplicantCreate {
|
|
|
436
467
|
*/
|
|
437
468
|
export interface ApplicantRequest {
|
|
438
469
|
/**
|
|
439
|
-
*
|
|
440
|
-
* @type {
|
|
470
|
+
* The applicant\'s consents
|
|
471
|
+
* @type {Array<ApplicantConsentBuilder>}
|
|
441
472
|
* @memberof ApplicantRequest
|
|
442
473
|
*/
|
|
443
|
-
'consents'?:
|
|
474
|
+
'consents'?: Array<ApplicantConsentBuilder>;
|
|
444
475
|
/**
|
|
445
476
|
*
|
|
446
477
|
* @type {AddressBuilder}
|
|
@@ -596,11 +627,11 @@ export interface ApplicantUpdater {
|
|
|
596
627
|
*/
|
|
597
628
|
'phone_number'?: string;
|
|
598
629
|
/**
|
|
599
|
-
*
|
|
600
|
-
* @type {
|
|
630
|
+
* The applicant\'s consents
|
|
631
|
+
* @type {Array<ApplicantConsentBuilder>}
|
|
601
632
|
* @memberof ApplicantUpdater
|
|
602
633
|
*/
|
|
603
|
-
'consents'?:
|
|
634
|
+
'consents'?: Array<ApplicantConsentBuilder>;
|
|
604
635
|
/**
|
|
605
636
|
*
|
|
606
637
|
* @type {AddressBuilder}
|
|
@@ -675,6 +706,12 @@ export interface Check {
|
|
|
675
706
|
* @memberof Check
|
|
676
707
|
*/
|
|
677
708
|
'redirect_uri'?: string;
|
|
709
|
+
/**
|
|
710
|
+
*
|
|
711
|
+
* @type {boolean}
|
|
712
|
+
* @memberof Check
|
|
713
|
+
*/
|
|
714
|
+
'privacy_notices_read_consent_given'?: boolean;
|
|
678
715
|
/**
|
|
679
716
|
* The unique identifier for the check.
|
|
680
717
|
* @type {string}
|
|
@@ -694,11 +731,11 @@ export interface Check {
|
|
|
694
731
|
*/
|
|
695
732
|
'href'?: string;
|
|
696
733
|
/**
|
|
697
|
-
*
|
|
698
|
-
* @type {
|
|
734
|
+
*
|
|
735
|
+
* @type {CheckStatus}
|
|
699
736
|
* @memberof Check
|
|
700
737
|
*/
|
|
701
|
-
'status'?:
|
|
738
|
+
'status'?: CheckStatus;
|
|
702
739
|
/**
|
|
703
740
|
* The overall result of the check, based on the results of the constituent reports.
|
|
704
741
|
* @type {string}
|
|
@@ -729,17 +766,19 @@ export interface Check {
|
|
|
729
766
|
* @memberof Check
|
|
730
767
|
*/
|
|
731
768
|
'sandbox'?: boolean;
|
|
769
|
+
/**
|
|
770
|
+
*
|
|
771
|
+
* @type {boolean}
|
|
772
|
+
* @memberof Check
|
|
773
|
+
*/
|
|
774
|
+
'paused'?: boolean;
|
|
775
|
+
/**
|
|
776
|
+
*
|
|
777
|
+
* @type {string}
|
|
778
|
+
* @memberof Check
|
|
779
|
+
*/
|
|
780
|
+
'version'?: string;
|
|
732
781
|
}
|
|
733
|
-
export declare const CheckStatusEnum: {
|
|
734
|
-
readonly InProgress: "in_progress";
|
|
735
|
-
readonly AwaitingApplicant: "awaiting_applicant";
|
|
736
|
-
readonly Complete: "complete";
|
|
737
|
-
readonly Withdrawn: "withdrawn";
|
|
738
|
-
readonly Paused: "paused";
|
|
739
|
-
readonly Reopened: "reopened";
|
|
740
|
-
readonly UnknownDefaultOpenApi: "11184809";
|
|
741
|
-
};
|
|
742
|
-
export type CheckStatusEnum = typeof CheckStatusEnum[keyof typeof CheckStatusEnum];
|
|
743
782
|
export declare const CheckResultEnum: {
|
|
744
783
|
readonly Clear: "clear";
|
|
745
784
|
readonly Consider: "consider";
|
|
@@ -782,6 +821,12 @@ export interface CheckBuilder {
|
|
|
782
821
|
* @memberof CheckBuilder
|
|
783
822
|
*/
|
|
784
823
|
'redirect_uri'?: string;
|
|
824
|
+
/**
|
|
825
|
+
*
|
|
826
|
+
* @type {boolean}
|
|
827
|
+
* @memberof CheckBuilder
|
|
828
|
+
*/
|
|
829
|
+
'privacy_notices_read_consent_given'?: boolean;
|
|
785
830
|
/**
|
|
786
831
|
* An array of report names (strings).
|
|
787
832
|
* @type {Array<ReportName>}
|
|
@@ -905,11 +950,11 @@ export interface CheckResponse {
|
|
|
905
950
|
*/
|
|
906
951
|
'href'?: string;
|
|
907
952
|
/**
|
|
908
|
-
*
|
|
909
|
-
* @type {
|
|
953
|
+
*
|
|
954
|
+
* @type {CheckStatus}
|
|
910
955
|
* @memberof CheckResponse
|
|
911
956
|
*/
|
|
912
|
-
'status'?:
|
|
957
|
+
'status'?: CheckStatus;
|
|
913
958
|
/**
|
|
914
959
|
* The overall result of the check, based on the results of the constituent reports.
|
|
915
960
|
* @type {string}
|
|
@@ -940,17 +985,19 @@ export interface CheckResponse {
|
|
|
940
985
|
* @memberof CheckResponse
|
|
941
986
|
*/
|
|
942
987
|
'sandbox'?: boolean;
|
|
988
|
+
/**
|
|
989
|
+
*
|
|
990
|
+
* @type {boolean}
|
|
991
|
+
* @memberof CheckResponse
|
|
992
|
+
*/
|
|
993
|
+
'paused'?: boolean;
|
|
994
|
+
/**
|
|
995
|
+
*
|
|
996
|
+
* @type {string}
|
|
997
|
+
* @memberof CheckResponse
|
|
998
|
+
*/
|
|
999
|
+
'version'?: string;
|
|
943
1000
|
}
|
|
944
|
-
export declare const CheckResponseStatusEnum: {
|
|
945
|
-
readonly InProgress: "in_progress";
|
|
946
|
-
readonly AwaitingApplicant: "awaiting_applicant";
|
|
947
|
-
readonly Complete: "complete";
|
|
948
|
-
readonly Withdrawn: "withdrawn";
|
|
949
|
-
readonly Paused: "paused";
|
|
950
|
-
readonly Reopened: "reopened";
|
|
951
|
-
readonly UnknownDefaultOpenApi: "11184809";
|
|
952
|
-
};
|
|
953
|
-
export type CheckResponseStatusEnum = typeof CheckResponseStatusEnum[keyof typeof CheckResponseStatusEnum];
|
|
954
1001
|
export declare const CheckResponseResultEnum: {
|
|
955
1002
|
readonly Clear: "clear";
|
|
956
1003
|
readonly Consider: "consider";
|
|
@@ -993,7 +1040,28 @@ export interface CheckShared {
|
|
|
993
1040
|
* @memberof CheckShared
|
|
994
1041
|
*/
|
|
995
1042
|
'redirect_uri'?: string;
|
|
1043
|
+
/**
|
|
1044
|
+
*
|
|
1045
|
+
* @type {boolean}
|
|
1046
|
+
* @memberof CheckShared
|
|
1047
|
+
*/
|
|
1048
|
+
'privacy_notices_read_consent_given'?: boolean;
|
|
996
1049
|
}
|
|
1050
|
+
/**
|
|
1051
|
+
* The current state of the check in the checking process.
|
|
1052
|
+
* @export
|
|
1053
|
+
* @enum {string}
|
|
1054
|
+
*/
|
|
1055
|
+
export declare const CheckStatus: {
|
|
1056
|
+
readonly InProgress: "in_progress";
|
|
1057
|
+
readonly AwaitingApplicant: "awaiting_applicant";
|
|
1058
|
+
readonly Complete: "complete";
|
|
1059
|
+
readonly Withdrawn: "withdrawn";
|
|
1060
|
+
readonly Paused: "paused";
|
|
1061
|
+
readonly Reopened: "reopened";
|
|
1062
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
1063
|
+
};
|
|
1064
|
+
export type CheckStatus = typeof CheckStatus[keyof typeof CheckStatus];
|
|
997
1065
|
/**
|
|
998
1066
|
*
|
|
999
1067
|
* @export
|
|
@@ -1026,39 +1094,6 @@ export interface CompleteTaskBuilder {
|
|
|
1026
1094
|
* @export
|
|
1027
1095
|
*/
|
|
1028
1096
|
export type CompleteTaskDataBuilder = Array<object> | object;
|
|
1029
|
-
/**
|
|
1030
|
-
* The applicant\'s consents
|
|
1031
|
-
* @export
|
|
1032
|
-
* @interface ConsentItem
|
|
1033
|
-
*/
|
|
1034
|
-
export interface ConsentItem {
|
|
1035
|
-
/**
|
|
1036
|
-
*
|
|
1037
|
-
* @type {string}
|
|
1038
|
-
* @memberof ConsentItem
|
|
1039
|
-
*/
|
|
1040
|
-
'name': ConsentItemNameEnum;
|
|
1041
|
-
/**
|
|
1042
|
-
*
|
|
1043
|
-
* @type {boolean}
|
|
1044
|
-
* @memberof ConsentItem
|
|
1045
|
-
*/
|
|
1046
|
-
'granted': boolean;
|
|
1047
|
-
}
|
|
1048
|
-
export declare const ConsentItemNameEnum: {
|
|
1049
|
-
readonly PrivacyNoticesRead: "privacy_notices_read";
|
|
1050
|
-
readonly SsnVerification: "ssn_verification";
|
|
1051
|
-
readonly PhoneNumberVerification: "phone_number_verification";
|
|
1052
|
-
readonly UnknownDefaultOpenApi: "11184809";
|
|
1053
|
-
};
|
|
1054
|
-
export type ConsentItemNameEnum = typeof ConsentItemNameEnum[keyof typeof ConsentItemNameEnum];
|
|
1055
|
-
/**
|
|
1056
|
-
*
|
|
1057
|
-
* @export
|
|
1058
|
-
* @interface ConsentsBuilder
|
|
1059
|
-
*/
|
|
1060
|
-
export interface ConsentsBuilder {
|
|
1061
|
-
}
|
|
1062
1097
|
/**
|
|
1063
1098
|
*
|
|
1064
1099
|
* @export
|
|
@@ -1473,34 +1508,6 @@ export interface DeviceIntelligenceBreakdownPropertiesDevice {
|
|
|
1473
1508
|
* @memberof DeviceIntelligenceBreakdownPropertiesDevice
|
|
1474
1509
|
*/
|
|
1475
1510
|
'fake_network_request'?: boolean;
|
|
1476
|
-
/**
|
|
1477
|
-
* The true operating system of the device.
|
|
1478
|
-
* @type {string}
|
|
1479
|
-
* @memberof DeviceIntelligenceBreakdownPropertiesDevice
|
|
1480
|
-
* @deprecated
|
|
1481
|
-
*/
|
|
1482
|
-
'true_os'?: string;
|
|
1483
|
-
/**
|
|
1484
|
-
* The likelihood of an operating system anomaly between the true OS and the OS sent by the device.
|
|
1485
|
-
* @type {string}
|
|
1486
|
-
* @memberof DeviceIntelligenceBreakdownPropertiesDevice
|
|
1487
|
-
* @deprecated
|
|
1488
|
-
*/
|
|
1489
|
-
'os_anomaly'?: string;
|
|
1490
|
-
/**
|
|
1491
|
-
* Whether the device is rooted.
|
|
1492
|
-
* @type {boolean}
|
|
1493
|
-
* @memberof DeviceIntelligenceBreakdownPropertiesDevice
|
|
1494
|
-
* @deprecated
|
|
1495
|
-
*/
|
|
1496
|
-
'rooted'?: boolean;
|
|
1497
|
-
/**
|
|
1498
|
-
* Whether the device is controlled via remote software.
|
|
1499
|
-
* @type {boolean}
|
|
1500
|
-
* @memberof DeviceIntelligenceBreakdownPropertiesDevice
|
|
1501
|
-
* @deprecated
|
|
1502
|
-
*/
|
|
1503
|
-
'remote_software'?: boolean;
|
|
1504
1511
|
/**
|
|
1505
1512
|
* Whether there is highly suspicious traffic related to the IP address. The risk depends on the overall ratio of clear checks on a given IP.
|
|
1506
1513
|
* @type {string}
|
|
@@ -1602,27 +1609,6 @@ export interface DeviceIntelligenceBreakdownPropertiesIp {
|
|
|
1602
1609
|
* @memberof DeviceIntelligenceBreakdownPropertiesIp
|
|
1603
1610
|
*/
|
|
1604
1611
|
'address'?: string;
|
|
1605
|
-
/**
|
|
1606
|
-
* The likelihood of the network connection being a VPN.
|
|
1607
|
-
* @type {string}
|
|
1608
|
-
* @memberof DeviceIntelligenceBreakdownPropertiesIp
|
|
1609
|
-
* @deprecated
|
|
1610
|
-
*/
|
|
1611
|
-
'vpn_detection'?: string;
|
|
1612
|
-
/**
|
|
1613
|
-
* The likelihood of the network connection being a Proxy.
|
|
1614
|
-
* @type {string}
|
|
1615
|
-
* @memberof DeviceIntelligenceBreakdownPropertiesIp
|
|
1616
|
-
* @deprecated
|
|
1617
|
-
*/
|
|
1618
|
-
'proxy_detection'?: string;
|
|
1619
|
-
/**
|
|
1620
|
-
* The type of organization that owns this IP address.
|
|
1621
|
-
* @type {string}
|
|
1622
|
-
* @memberof DeviceIntelligenceBreakdownPropertiesIp
|
|
1623
|
-
* @deprecated
|
|
1624
|
-
*/
|
|
1625
|
-
'type'?: string;
|
|
1626
1612
|
}
|
|
1627
1613
|
/**
|
|
1628
1614
|
*
|
|
@@ -1705,10 +1691,10 @@ export interface Document {
|
|
|
1705
1691
|
'file_type'?: DocumentFileTypeEnum;
|
|
1706
1692
|
/**
|
|
1707
1693
|
* The type of document
|
|
1708
|
-
* @type {
|
|
1694
|
+
* @type {DocumentTypes}
|
|
1709
1695
|
* @memberof Document
|
|
1710
1696
|
*/
|
|
1711
|
-
'type'?:
|
|
1697
|
+
'type'?: DocumentTypes;
|
|
1712
1698
|
/**
|
|
1713
1699
|
* The side of the document, if applicable. The possible values are front and back
|
|
1714
1700
|
* @type {string}
|
|
@@ -3673,10 +3659,10 @@ export interface DocumentShared {
|
|
|
3673
3659
|
'file_type'?: DocumentSharedFileTypeEnum;
|
|
3674
3660
|
/**
|
|
3675
3661
|
* The type of document
|
|
3676
|
-
* @type {
|
|
3662
|
+
* @type {DocumentTypes}
|
|
3677
3663
|
* @memberof DocumentShared
|
|
3678
3664
|
*/
|
|
3679
|
-
'type'?:
|
|
3665
|
+
'type'?: DocumentTypes;
|
|
3680
3666
|
/**
|
|
3681
3667
|
* The side of the document, if applicable. The possible values are front and back
|
|
3682
3668
|
* @type {string}
|
|
@@ -3741,6 +3727,11 @@ export declare const DocumentTypes: {
|
|
|
3741
3727
|
readonly ProfessionalQualificationCard: "professional_qualification_card";
|
|
3742
3728
|
readonly ConsularId: "consular_id";
|
|
3743
3729
|
readonly InternationalDrivingLicence: "international_driving_licence";
|
|
3730
|
+
readonly HomeOfficeLetter: "home_office_letter";
|
|
3731
|
+
readonly BirthCertificate: "birth_certificate";
|
|
3732
|
+
readonly VehicleRegistrationCertificate: "vehicle_registration_certificate";
|
|
3733
|
+
readonly FormForAffixingTheVisa: "form_for_affixing_the_visa";
|
|
3734
|
+
readonly IdentificationNumberDocument: "identification_number_document";
|
|
3744
3735
|
readonly UnknownDefaultOpenApi: "11184809";
|
|
3745
3736
|
};
|
|
3746
3737
|
export type DocumentTypes = typeof DocumentTypes[keyof typeof DocumentTypes];
|
|
@@ -7925,12 +7916,24 @@ export interface TaskItem {
|
|
|
7925
7916
|
* @memberof TaskItem
|
|
7926
7917
|
*/
|
|
7927
7918
|
'id'?: string;
|
|
7919
|
+
/**
|
|
7920
|
+
* The workflow run id the task belongs to.
|
|
7921
|
+
* @type {string}
|
|
7922
|
+
* @memberof TaskItem
|
|
7923
|
+
*/
|
|
7924
|
+
'workflow_run_id'?: string;
|
|
7928
7925
|
/**
|
|
7929
7926
|
* The identifier for the Task Definition.
|
|
7930
7927
|
* @type {string}
|
|
7931
7928
|
* @memberof TaskItem
|
|
7932
7929
|
*/
|
|
7933
7930
|
'task_def_id'?: string;
|
|
7931
|
+
/**
|
|
7932
|
+
* The task definition version.
|
|
7933
|
+
* @type {string}
|
|
7934
|
+
* @memberof TaskItem
|
|
7935
|
+
*/
|
|
7936
|
+
'task_def_version'?: string | null;
|
|
7934
7937
|
/**
|
|
7935
7938
|
* The date and time when the Task was created.
|
|
7936
7939
|
* @type {string}
|
|
@@ -8683,6 +8686,7 @@ export interface WatchlistAmlProperties {
|
|
|
8683
8686
|
* Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
|
|
8684
8687
|
* @type {Array<string>}
|
|
8685
8688
|
* @memberof WatchlistAmlProperties
|
|
8689
|
+
* @deprecated
|
|
8686
8690
|
*/
|
|
8687
8691
|
'records'?: Array<string>;
|
|
8688
8692
|
}
|
|
@@ -8798,120 +8802,386 @@ export interface WatchlistEnhancedBreakdown {
|
|
|
8798
8802
|
export interface WatchlistEnhancedProperties {
|
|
8799
8803
|
/**
|
|
8800
8804
|
* Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
|
|
8801
|
-
* @type {Array<
|
|
8805
|
+
* @type {Array<WatchlistEnhancedPropertiesRecordsInner>}
|
|
8802
8806
|
* @memberof WatchlistEnhancedProperties
|
|
8803
8807
|
*/
|
|
8804
|
-
'records'?: Array<
|
|
8808
|
+
'records'?: Array<WatchlistEnhancedPropertiesRecordsInner>;
|
|
8805
8809
|
}
|
|
8806
8810
|
/**
|
|
8807
8811
|
*
|
|
8808
8812
|
* @export
|
|
8809
|
-
* @interface
|
|
8813
|
+
* @interface WatchlistEnhancedPropertiesRecordsInner
|
|
8810
8814
|
*/
|
|
8811
|
-
export interface
|
|
8815
|
+
export interface WatchlistEnhancedPropertiesRecordsInner {
|
|
8812
8816
|
/**
|
|
8813
|
-
*
|
|
8814
|
-
* @type {
|
|
8815
|
-
* @memberof
|
|
8817
|
+
* All addresses on file.
|
|
8818
|
+
* @type {Array<WatchlistEnhancedPropertiesRecordsInnerAddressInner>}
|
|
8819
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInner
|
|
8816
8820
|
*/
|
|
8817
|
-
'
|
|
8821
|
+
'address'?: Array<WatchlistEnhancedPropertiesRecordsInnerAddressInner>;
|
|
8818
8822
|
/**
|
|
8819
|
-
*
|
|
8820
|
-
* @type {
|
|
8821
|
-
* @memberof
|
|
8823
|
+
* Any names that the person is also known as.
|
|
8824
|
+
* @type {Array<WatchlistEnhancedPropertiesRecordsInnerAliasInner>}
|
|
8825
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInner
|
|
8822
8826
|
*/
|
|
8823
|
-
'
|
|
8827
|
+
'alias'?: Array<WatchlistEnhancedPropertiesRecordsInnerAliasInner>;
|
|
8824
8828
|
/**
|
|
8825
|
-
*
|
|
8826
|
-
* @type {
|
|
8827
|
-
* @memberof
|
|
8829
|
+
* Any linked persons, for example family relatives or business partners.
|
|
8830
|
+
* @type {Array<WatchlistEnhancedPropertiesRecordsInnerAssociateInner>}
|
|
8831
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInner
|
|
8828
8832
|
*/
|
|
8829
|
-
'
|
|
8833
|
+
'associate'?: Array<WatchlistEnhancedPropertiesRecordsInnerAssociateInner>;
|
|
8830
8834
|
/**
|
|
8831
|
-
*
|
|
8832
|
-
* @type {
|
|
8833
|
-
* @memberof
|
|
8835
|
+
* Information about the person, for example hair color or nationality.
|
|
8836
|
+
* @type {Array<WatchlistEnhancedPropertiesRecordsInnerAttributeInner>}
|
|
8837
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInner
|
|
8834
8838
|
*/
|
|
8835
|
-
'
|
|
8839
|
+
'attribute'?: Array<WatchlistEnhancedPropertiesRecordsInnerAttributeInner>;
|
|
8836
8840
|
/**
|
|
8837
|
-
*
|
|
8838
|
-
* @type {
|
|
8839
|
-
* @memberof
|
|
8841
|
+
* All the date of births on file.
|
|
8842
|
+
* @type {Array<string>}
|
|
8843
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInner
|
|
8840
8844
|
*/
|
|
8841
|
-
'
|
|
8845
|
+
'date_of_birth'?: Array<string>;
|
|
8842
8846
|
/**
|
|
8843
|
-
*
|
|
8844
|
-
* @type {
|
|
8845
|
-
* @memberof
|
|
8847
|
+
* Information about events that have occurred to the person, for example deportation or arrest.
|
|
8848
|
+
* @type {Array<WatchlistEnhancedPropertiesRecordsInnerEventInner>}
|
|
8849
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInner
|
|
8846
8850
|
*/
|
|
8847
|
-
'
|
|
8851
|
+
'event'?: Array<WatchlistEnhancedPropertiesRecordsInnerEventInner>;
|
|
8848
8852
|
/**
|
|
8849
|
-
* The
|
|
8853
|
+
* The name on file
|
|
8850
8854
|
* @type {string}
|
|
8851
|
-
* @memberof
|
|
8852
|
-
*/
|
|
8853
|
-
'check_id'?: string;
|
|
8854
|
-
/**
|
|
8855
|
-
* Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
|
|
8856
|
-
* @type {Array<ReportDocument>}
|
|
8857
|
-
* @memberof WatchlistEnhancedReport
|
|
8858
|
-
*/
|
|
8859
|
-
'documents'?: Array<ReportDocument>;
|
|
8860
|
-
/**
|
|
8861
|
-
*
|
|
8862
|
-
* @type {ReportName}
|
|
8863
|
-
* @memberof WatchlistEnhancedReport
|
|
8855
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInner
|
|
8864
8856
|
*/
|
|
8865
|
-
'
|
|
8857
|
+
'full_name'?: string;
|
|
8866
8858
|
/**
|
|
8867
|
-
*
|
|
8868
|
-
* @type {
|
|
8869
|
-
* @memberof
|
|
8859
|
+
* The role, country and date of each position.
|
|
8860
|
+
* @type {Array<string>}
|
|
8861
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInner
|
|
8870
8862
|
*/
|
|
8871
|
-
'
|
|
8863
|
+
'position'?: Array<string>;
|
|
8872
8864
|
/**
|
|
8873
|
-
*
|
|
8874
|
-
* @type {
|
|
8875
|
-
* @memberof
|
|
8865
|
+
* Details about where the information was obtained.
|
|
8866
|
+
* @type {Array<WatchlistEnhancedPropertiesRecordsInnerSourceInner>}
|
|
8867
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInner
|
|
8876
8868
|
*/
|
|
8877
|
-
'
|
|
8869
|
+
'source'?: Array<WatchlistEnhancedPropertiesRecordsInnerSourceInner>;
|
|
8878
8870
|
}
|
|
8879
8871
|
/**
|
|
8880
8872
|
*
|
|
8881
8873
|
* @export
|
|
8882
|
-
* @interface
|
|
8874
|
+
* @interface WatchlistEnhancedPropertiesRecordsInnerAddressInner
|
|
8883
8875
|
*/
|
|
8884
|
-
export interface
|
|
8876
|
+
export interface WatchlistEnhancedPropertiesRecordsInnerAddressInner {
|
|
8885
8877
|
/**
|
|
8886
|
-
*
|
|
8878
|
+
*
|
|
8887
8879
|
* @type {string}
|
|
8888
|
-
* @memberof
|
|
8880
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
|
|
8889
8881
|
*/
|
|
8890
|
-
'
|
|
8882
|
+
'address_line1'?: string;
|
|
8891
8883
|
/**
|
|
8892
|
-
*
|
|
8893
|
-
* @type {
|
|
8894
|
-
* @memberof
|
|
8884
|
+
*
|
|
8885
|
+
* @type {CountryCodes}
|
|
8886
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
|
|
8895
8887
|
*/
|
|
8896
|
-
'
|
|
8888
|
+
'country'?: CountryCodes;
|
|
8897
8889
|
/**
|
|
8898
|
-
*
|
|
8899
|
-
* @type {
|
|
8900
|
-
* @memberof
|
|
8890
|
+
*
|
|
8891
|
+
* @type {string}
|
|
8892
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
|
|
8901
8893
|
*/
|
|
8902
|
-
'
|
|
8894
|
+
'postal_code'?: string;
|
|
8903
8895
|
/**
|
|
8904
|
-
*
|
|
8896
|
+
*
|
|
8905
8897
|
* @type {string}
|
|
8906
|
-
* @memberof
|
|
8898
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
|
|
8907
8899
|
*/
|
|
8908
|
-
'
|
|
8900
|
+
'state_province'?: string;
|
|
8909
8901
|
/**
|
|
8910
|
-
*
|
|
8902
|
+
*
|
|
8911
8903
|
* @type {string}
|
|
8912
|
-
* @memberof
|
|
8904
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
|
|
8913
8905
|
*/
|
|
8914
|
-
'
|
|
8906
|
+
'town'?: string;
|
|
8907
|
+
/**
|
|
8908
|
+
*
|
|
8909
|
+
* @type {string}
|
|
8910
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
|
|
8911
|
+
*/
|
|
8912
|
+
'locator_type'?: string;
|
|
8913
|
+
}
|
|
8914
|
+
/**
|
|
8915
|
+
*
|
|
8916
|
+
* @export
|
|
8917
|
+
* @interface WatchlistEnhancedPropertiesRecordsInnerAliasInner
|
|
8918
|
+
*/
|
|
8919
|
+
export interface WatchlistEnhancedPropertiesRecordsInnerAliasInner {
|
|
8920
|
+
/**
|
|
8921
|
+
*
|
|
8922
|
+
* @type {string}
|
|
8923
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAliasInner
|
|
8924
|
+
*/
|
|
8925
|
+
'alias_name'?: string;
|
|
8926
|
+
/**
|
|
8927
|
+
*
|
|
8928
|
+
* @type {string}
|
|
8929
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAliasInner
|
|
8930
|
+
*/
|
|
8931
|
+
'alias_type'?: string;
|
|
8932
|
+
}
|
|
8933
|
+
/**
|
|
8934
|
+
*
|
|
8935
|
+
* @export
|
|
8936
|
+
* @interface WatchlistEnhancedPropertiesRecordsInnerAssociateInner
|
|
8937
|
+
*/
|
|
8938
|
+
export interface WatchlistEnhancedPropertiesRecordsInnerAssociateInner {
|
|
8939
|
+
/**
|
|
8940
|
+
*
|
|
8941
|
+
* @type {string}
|
|
8942
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAssociateInner
|
|
8943
|
+
*/
|
|
8944
|
+
'entity_name'?: string;
|
|
8945
|
+
/**
|
|
8946
|
+
*
|
|
8947
|
+
* @type {string}
|
|
8948
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAssociateInner
|
|
8949
|
+
*/
|
|
8950
|
+
'relationship_direction'?: string;
|
|
8951
|
+
/**
|
|
8952
|
+
*
|
|
8953
|
+
* @type {string}
|
|
8954
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAssociateInner
|
|
8955
|
+
*/
|
|
8956
|
+
'relationship_type'?: string;
|
|
8957
|
+
}
|
|
8958
|
+
/**
|
|
8959
|
+
*
|
|
8960
|
+
* @export
|
|
8961
|
+
* @interface WatchlistEnhancedPropertiesRecordsInnerAttributeInner
|
|
8962
|
+
*/
|
|
8963
|
+
export interface WatchlistEnhancedPropertiesRecordsInnerAttributeInner {
|
|
8964
|
+
/**
|
|
8965
|
+
*
|
|
8966
|
+
* @type {string}
|
|
8967
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAttributeInner
|
|
8968
|
+
*/
|
|
8969
|
+
'attribute_type'?: string;
|
|
8970
|
+
/**
|
|
8971
|
+
*
|
|
8972
|
+
* @type {string}
|
|
8973
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerAttributeInner
|
|
8974
|
+
*/
|
|
8975
|
+
'attribute_value'?: string;
|
|
8976
|
+
}
|
|
8977
|
+
/**
|
|
8978
|
+
*
|
|
8979
|
+
* @export
|
|
8980
|
+
* @interface WatchlistEnhancedPropertiesRecordsInnerEventInner
|
|
8981
|
+
*/
|
|
8982
|
+
export interface WatchlistEnhancedPropertiesRecordsInnerEventInner {
|
|
8983
|
+
/**
|
|
8984
|
+
*
|
|
8985
|
+
* @type {string}
|
|
8986
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
|
|
8987
|
+
*/
|
|
8988
|
+
'category'?: string;
|
|
8989
|
+
/**
|
|
8990
|
+
*
|
|
8991
|
+
* @type {string}
|
|
8992
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
|
|
8993
|
+
*/
|
|
8994
|
+
'event_date'?: string;
|
|
8995
|
+
/**
|
|
8996
|
+
*
|
|
8997
|
+
* @type {string}
|
|
8998
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
|
|
8999
|
+
*/
|
|
9000
|
+
'event_description'?: string;
|
|
9001
|
+
/**
|
|
9002
|
+
*
|
|
9003
|
+
* @type {WatchlistEnhancedPropertiesRecordsInnerEventInnerSource}
|
|
9004
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
|
|
9005
|
+
*/
|
|
9006
|
+
'source'?: WatchlistEnhancedPropertiesRecordsInnerEventInnerSource;
|
|
9007
|
+
/**
|
|
9008
|
+
*
|
|
9009
|
+
* @type {string}
|
|
9010
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
|
|
9011
|
+
*/
|
|
9012
|
+
'sub_category'?: string;
|
|
9013
|
+
}
|
|
9014
|
+
/**
|
|
9015
|
+
*
|
|
9016
|
+
* @export
|
|
9017
|
+
* @interface WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
|
|
9018
|
+
*/
|
|
9019
|
+
export interface WatchlistEnhancedPropertiesRecordsInnerEventInnerSource {
|
|
9020
|
+
/**
|
|
9021
|
+
*
|
|
9022
|
+
* @type {string}
|
|
9023
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
|
|
9024
|
+
*/
|
|
9025
|
+
'source_date'?: string;
|
|
9026
|
+
/**
|
|
9027
|
+
*
|
|
9028
|
+
* @type {string}
|
|
9029
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
|
|
9030
|
+
*/
|
|
9031
|
+
'source_format'?: string;
|
|
9032
|
+
/**
|
|
9033
|
+
*
|
|
9034
|
+
* @type {string}
|
|
9035
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
|
|
9036
|
+
*/
|
|
9037
|
+
'source_name'?: string;
|
|
9038
|
+
/**
|
|
9039
|
+
*
|
|
9040
|
+
* @type {string}
|
|
9041
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
|
|
9042
|
+
*/
|
|
9043
|
+
'source_url'?: string;
|
|
9044
|
+
}
|
|
9045
|
+
/**
|
|
9046
|
+
*
|
|
9047
|
+
* @export
|
|
9048
|
+
* @interface WatchlistEnhancedPropertiesRecordsInnerSourceInner
|
|
9049
|
+
*/
|
|
9050
|
+
export interface WatchlistEnhancedPropertiesRecordsInnerSourceInner {
|
|
9051
|
+
/**
|
|
9052
|
+
*
|
|
9053
|
+
* @type {string}
|
|
9054
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
|
|
9055
|
+
*/
|
|
9056
|
+
'source_headline'?: string;
|
|
9057
|
+
/**
|
|
9058
|
+
*
|
|
9059
|
+
* @type {string}
|
|
9060
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
|
|
9061
|
+
*/
|
|
9062
|
+
'source_name'?: string;
|
|
9063
|
+
/**
|
|
9064
|
+
*
|
|
9065
|
+
* @type {string}
|
|
9066
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
|
|
9067
|
+
*/
|
|
9068
|
+
'source_url'?: string;
|
|
9069
|
+
/**
|
|
9070
|
+
*
|
|
9071
|
+
* @type {string}
|
|
9072
|
+
* @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
|
|
9073
|
+
*/
|
|
9074
|
+
'source_format'?: string;
|
|
9075
|
+
}
|
|
9076
|
+
/**
|
|
9077
|
+
*
|
|
9078
|
+
* @export
|
|
9079
|
+
* @interface WatchlistEnhancedReport
|
|
9080
|
+
*/
|
|
9081
|
+
export interface WatchlistEnhancedReport {
|
|
9082
|
+
/**
|
|
9083
|
+
* The unique identifier for the report. Read-only.
|
|
9084
|
+
* @type {string}
|
|
9085
|
+
* @memberof WatchlistEnhancedReport
|
|
9086
|
+
*/
|
|
9087
|
+
'id': string;
|
|
9088
|
+
/**
|
|
9089
|
+
* The date and time at which the report was first initiated. Read-only.
|
|
9090
|
+
* @type {string}
|
|
9091
|
+
* @memberof WatchlistEnhancedReport
|
|
9092
|
+
*/
|
|
9093
|
+
'created_at'?: string;
|
|
9094
|
+
/**
|
|
9095
|
+
* The API endpoint to retrieve the report. Read-only.
|
|
9096
|
+
* @type {string}
|
|
9097
|
+
* @memberof WatchlistEnhancedReport
|
|
9098
|
+
*/
|
|
9099
|
+
'href'?: string;
|
|
9100
|
+
/**
|
|
9101
|
+
*
|
|
9102
|
+
* @type {ReportStatus}
|
|
9103
|
+
* @memberof WatchlistEnhancedReport
|
|
9104
|
+
*/
|
|
9105
|
+
'status'?: ReportStatus;
|
|
9106
|
+
/**
|
|
9107
|
+
*
|
|
9108
|
+
* @type {ReportResult}
|
|
9109
|
+
* @memberof WatchlistEnhancedReport
|
|
9110
|
+
*/
|
|
9111
|
+
'result'?: ReportResult;
|
|
9112
|
+
/**
|
|
9113
|
+
*
|
|
9114
|
+
* @type {ReportSubResult}
|
|
9115
|
+
* @memberof WatchlistEnhancedReport
|
|
9116
|
+
*/
|
|
9117
|
+
'sub_result'?: ReportSubResult;
|
|
9118
|
+
/**
|
|
9119
|
+
* The ID of the check to which the report belongs. Read-only.
|
|
9120
|
+
* @type {string}
|
|
9121
|
+
* @memberof WatchlistEnhancedReport
|
|
9122
|
+
*/
|
|
9123
|
+
'check_id'?: string;
|
|
9124
|
+
/**
|
|
9125
|
+
* Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
|
|
9126
|
+
* @type {Array<ReportDocument>}
|
|
9127
|
+
* @memberof WatchlistEnhancedReport
|
|
9128
|
+
*/
|
|
9129
|
+
'documents'?: Array<ReportDocument>;
|
|
9130
|
+
/**
|
|
9131
|
+
*
|
|
9132
|
+
* @type {ReportName}
|
|
9133
|
+
* @memberof WatchlistEnhancedReport
|
|
9134
|
+
*/
|
|
9135
|
+
'name': ReportName;
|
|
9136
|
+
/**
|
|
9137
|
+
*
|
|
9138
|
+
* @type {WatchlistEnhancedBreakdown}
|
|
9139
|
+
* @memberof WatchlistEnhancedReport
|
|
9140
|
+
*/
|
|
9141
|
+
'breakdown'?: WatchlistEnhancedBreakdown;
|
|
9142
|
+
/**
|
|
9143
|
+
*
|
|
9144
|
+
* @type {WatchlistEnhancedProperties}
|
|
9145
|
+
* @memberof WatchlistEnhancedReport
|
|
9146
|
+
*/
|
|
9147
|
+
'properties'?: WatchlistEnhancedProperties;
|
|
9148
|
+
}
|
|
9149
|
+
/**
|
|
9150
|
+
*
|
|
9151
|
+
* @export
|
|
9152
|
+
* @interface WatchlistMonitor
|
|
9153
|
+
*/
|
|
9154
|
+
export interface WatchlistMonitor {
|
|
9155
|
+
/**
|
|
9156
|
+
* The ID for the applicant associated with the monitor.
|
|
9157
|
+
* @type {string}
|
|
9158
|
+
* @memberof WatchlistMonitor
|
|
9159
|
+
*/
|
|
9160
|
+
'applicant_id': string;
|
|
9161
|
+
/**
|
|
9162
|
+
* The name of the report type the monitor creates.
|
|
9163
|
+
* @type {string}
|
|
9164
|
+
* @memberof WatchlistMonitor
|
|
9165
|
+
*/
|
|
9166
|
+
'report_name': WatchlistMonitorReportNameEnum;
|
|
9167
|
+
/**
|
|
9168
|
+
* A list of tags associated with this monitor. These tags will be applied to each check this monitor creates.
|
|
9169
|
+
* @type {Array<string>}
|
|
9170
|
+
* @memberof WatchlistMonitor
|
|
9171
|
+
*/
|
|
9172
|
+
'tags'?: Array<string>;
|
|
9173
|
+
/**
|
|
9174
|
+
* The unique identifier for the monitor.
|
|
9175
|
+
* @type {string}
|
|
9176
|
+
* @memberof WatchlistMonitor
|
|
9177
|
+
*/
|
|
9178
|
+
'id': string;
|
|
9179
|
+
/**
|
|
9180
|
+
* The date and time at which the monitor was created.
|
|
9181
|
+
* @type {string}
|
|
9182
|
+
* @memberof WatchlistMonitor
|
|
9183
|
+
*/
|
|
9184
|
+
'created_at'?: string;
|
|
8915
9185
|
/**
|
|
8916
9186
|
* The date and time at which the monitor was deleted. If the monitor is still active, this field will be null.
|
|
8917
9187
|
* @type {string}
|
|
@@ -9269,6 +9539,7 @@ export interface WatchlistStandardProperties {
|
|
|
9269
9539
|
* Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
|
|
9270
9540
|
* @type {Array<string>}
|
|
9271
9541
|
* @memberof WatchlistStandardProperties
|
|
9542
|
+
* @deprecated
|
|
9272
9543
|
*/
|
|
9273
9544
|
'records'?: Array<string>;
|
|
9274
9545
|
}
|
|
@@ -9463,6 +9734,34 @@ export interface WebhookEvent {
|
|
|
9463
9734
|
*/
|
|
9464
9735
|
'payload'?: WebhookEventPayload;
|
|
9465
9736
|
}
|
|
9737
|
+
/**
|
|
9738
|
+
* The current state of the object, if available.
|
|
9739
|
+
* @export
|
|
9740
|
+
* @enum {string}
|
|
9741
|
+
*/
|
|
9742
|
+
export declare const WebhookEventObjectStatus: {
|
|
9743
|
+
readonly Processing: "processing";
|
|
9744
|
+
readonly AwaitingInput: "awaiting_input";
|
|
9745
|
+
readonly AwaitingClientInput: "awaiting_client_input";
|
|
9746
|
+
readonly Approved: "approved";
|
|
9747
|
+
readonly Declined: "declined";
|
|
9748
|
+
readonly Review: "review";
|
|
9749
|
+
readonly Abandoned: "abandoned";
|
|
9750
|
+
readonly Error: "error";
|
|
9751
|
+
readonly Started: "started";
|
|
9752
|
+
readonly Cancelled: "cancelled";
|
|
9753
|
+
readonly Completed: "completed";
|
|
9754
|
+
readonly AwaitingData: "awaiting_data";
|
|
9755
|
+
readonly AwaitingApproval: "awaiting_approval";
|
|
9756
|
+
readonly Complete: "complete";
|
|
9757
|
+
readonly Withdrawn: "withdrawn";
|
|
9758
|
+
readonly InProgress: "in_progress";
|
|
9759
|
+
readonly AwaitingApplicant: "awaiting_applicant";
|
|
9760
|
+
readonly Paused: "paused";
|
|
9761
|
+
readonly Reopened: "reopened";
|
|
9762
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
9763
|
+
};
|
|
9764
|
+
export type WebhookEventObjectStatus = typeof WebhookEventObjectStatus[keyof typeof WebhookEventObjectStatus];
|
|
9466
9765
|
/**
|
|
9467
9766
|
*
|
|
9468
9767
|
* @export
|
|
@@ -9471,10 +9770,10 @@ export interface WebhookEvent {
|
|
|
9471
9770
|
export interface WebhookEventPayload {
|
|
9472
9771
|
/**
|
|
9473
9772
|
* Indicates the resource affected by this event.
|
|
9474
|
-
* @type {
|
|
9773
|
+
* @type {WebhookEventResourceType}
|
|
9475
9774
|
* @memberof WebhookEventPayload
|
|
9476
9775
|
*/
|
|
9477
|
-
'resource_type':
|
|
9776
|
+
'resource_type': WebhookEventResourceType;
|
|
9478
9777
|
/**
|
|
9479
9778
|
* The event that triggered this webhook.
|
|
9480
9779
|
* @type {WebhookEventType}
|
|
@@ -9488,11 +9787,11 @@ export interface WebhookEventPayload {
|
|
|
9488
9787
|
*/
|
|
9489
9788
|
'object'?: WebhookEventPayloadObject;
|
|
9490
9789
|
/**
|
|
9491
|
-
*
|
|
9492
|
-
* @type {
|
|
9790
|
+
*
|
|
9791
|
+
* @type {WebhookEventPayloadResource}
|
|
9493
9792
|
* @memberof WebhookEventPayload
|
|
9494
9793
|
*/
|
|
9495
|
-
'resource'?:
|
|
9794
|
+
'resource'?: WebhookEventPayloadResource;
|
|
9496
9795
|
}
|
|
9497
9796
|
/**
|
|
9498
9797
|
* The object affected by this event.
|
|
@@ -9507,11 +9806,11 @@ export interface WebhookEventPayloadObject {
|
|
|
9507
9806
|
*/
|
|
9508
9807
|
'id': string;
|
|
9509
9808
|
/**
|
|
9510
|
-
*
|
|
9511
|
-
* @type {
|
|
9809
|
+
*
|
|
9810
|
+
* @type {WebhookEventObjectStatus}
|
|
9512
9811
|
* @memberof WebhookEventPayloadObject
|
|
9513
9812
|
*/
|
|
9514
|
-
'status'?:
|
|
9813
|
+
'status'?: WebhookEventObjectStatus;
|
|
9515
9814
|
/**
|
|
9516
9815
|
* The date and time when the operation was started, if available.
|
|
9517
9816
|
* @type {string}
|
|
@@ -9531,6 +9830,118 @@ export interface WebhookEventPayloadObject {
|
|
|
9531
9830
|
*/
|
|
9532
9831
|
'href': string;
|
|
9533
9832
|
}
|
|
9833
|
+
/**
|
|
9834
|
+
* The resource affected by this event.
|
|
9835
|
+
* @export
|
|
9836
|
+
* @interface WebhookEventPayloadResource
|
|
9837
|
+
*/
|
|
9838
|
+
export interface WebhookEventPayloadResource {
|
|
9839
|
+
/**
|
|
9840
|
+
* The identifier of the resource.
|
|
9841
|
+
* @type {string}
|
|
9842
|
+
* @memberof WebhookEventPayloadResource
|
|
9843
|
+
*/
|
|
9844
|
+
'id'?: string;
|
|
9845
|
+
/**
|
|
9846
|
+
* The unique identifier for the Applicant.
|
|
9847
|
+
* @type {string}
|
|
9848
|
+
* @memberof WebhookEventPayloadResource
|
|
9849
|
+
*/
|
|
9850
|
+
'applicant_id'?: string;
|
|
9851
|
+
/**
|
|
9852
|
+
* The date and time when the resource was created.
|
|
9853
|
+
* @type {string}
|
|
9854
|
+
* @memberof WebhookEventPayloadResource
|
|
9855
|
+
*/
|
|
9856
|
+
'created_at'?: string;
|
|
9857
|
+
/**
|
|
9858
|
+
* The date and time when the resource was last updated.
|
|
9859
|
+
* @type {string}
|
|
9860
|
+
* @memberof WebhookEventPayloadResource
|
|
9861
|
+
*/
|
|
9862
|
+
'updated_at'?: string;
|
|
9863
|
+
/**
|
|
9864
|
+
* The URL for viewing the resource on Onfido Dashboard.
|
|
9865
|
+
* @type {string}
|
|
9866
|
+
* @memberof WebhookEventPayloadResource
|
|
9867
|
+
*/
|
|
9868
|
+
'dashboard_url'?: string;
|
|
9869
|
+
/**
|
|
9870
|
+
* The unique identifier for the Workflow.
|
|
9871
|
+
* @type {string}
|
|
9872
|
+
* @memberof WebhookEventPayloadResource
|
|
9873
|
+
*/
|
|
9874
|
+
'workflow_id'?: string;
|
|
9875
|
+
/**
|
|
9876
|
+
*
|
|
9877
|
+
* @type {string}
|
|
9878
|
+
* @memberof WebhookEventPayloadResource
|
|
9879
|
+
*/
|
|
9880
|
+
'workflow_run_id'?: string;
|
|
9881
|
+
/**
|
|
9882
|
+
* The identifier for the Workflow version.
|
|
9883
|
+
* @type {number}
|
|
9884
|
+
* @memberof WebhookEventPayloadResource
|
|
9885
|
+
*/
|
|
9886
|
+
'workflow_version_id'?: number;
|
|
9887
|
+
/**
|
|
9888
|
+
* The identifier for the Task Definition.
|
|
9889
|
+
* @type {string}
|
|
9890
|
+
* @memberof WebhookEventPayloadResource
|
|
9891
|
+
*/
|
|
9892
|
+
'task_def_id'?: string;
|
|
9893
|
+
/**
|
|
9894
|
+
* The task definition version.
|
|
9895
|
+
* @type {string}
|
|
9896
|
+
* @memberof WebhookEventPayloadResource
|
|
9897
|
+
*/
|
|
9898
|
+
'task_def_version'?: string | null;
|
|
9899
|
+
/**
|
|
9900
|
+
* Input object with the fields used by the Task execution.
|
|
9901
|
+
* @type {object}
|
|
9902
|
+
* @memberof WebhookEventPayloadResource
|
|
9903
|
+
*/
|
|
9904
|
+
'input'?: object;
|
|
9905
|
+
/**
|
|
9906
|
+
* Output object with the fields produced by the Task execution.
|
|
9907
|
+
* @type {object}
|
|
9908
|
+
* @memberof WebhookEventPayloadResource
|
|
9909
|
+
*/
|
|
9910
|
+
'output'?: object | null;
|
|
9911
|
+
/**
|
|
9912
|
+
* The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow Version.
|
|
9913
|
+
* @type {Array<string>}
|
|
9914
|
+
* @memberof WebhookEventPayloadResource
|
|
9915
|
+
*/
|
|
9916
|
+
'reasons'?: Array<string>;
|
|
9917
|
+
/**
|
|
9918
|
+
* Object for the configuration of the Workflow Run link.
|
|
9919
|
+
* @type {WorkflowRunLink}
|
|
9920
|
+
* @memberof WebhookEventPayloadResource
|
|
9921
|
+
*/
|
|
9922
|
+
'link'?: WorkflowRunLink;
|
|
9923
|
+
/**
|
|
9924
|
+
* Error object that details why a Workflow Run is in Error status.
|
|
9925
|
+
* @type {WorkflowRunError}
|
|
9926
|
+
* @memberof WebhookEventPayloadResource
|
|
9927
|
+
*/
|
|
9928
|
+
'error'?: WorkflowRunError;
|
|
9929
|
+
}
|
|
9930
|
+
/**
|
|
9931
|
+
*
|
|
9932
|
+
* @export
|
|
9933
|
+
* @enum {string}
|
|
9934
|
+
*/
|
|
9935
|
+
export declare const WebhookEventResourceType: {
|
|
9936
|
+
readonly Check: "check";
|
|
9937
|
+
readonly Report: "report";
|
|
9938
|
+
readonly AuditLog: "audit_log";
|
|
9939
|
+
readonly WorkflowRun: "workflow_run";
|
|
9940
|
+
readonly WorkflowTask: "workflow_task";
|
|
9941
|
+
readonly WatchlistMonitor: "watchlist_monitor";
|
|
9942
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
9943
|
+
};
|
|
9944
|
+
export type WebhookEventResourceType = typeof WebhookEventResourceType[keyof typeof WebhookEventResourceType];
|
|
9534
9945
|
/**
|
|
9535
9946
|
*
|
|
9536
9947
|
* @export
|
|
@@ -9745,11 +10156,11 @@ export interface WorkflowRun {
|
|
|
9745
10156
|
*/
|
|
9746
10157
|
'customer_user_id'?: string;
|
|
9747
10158
|
/**
|
|
9748
|
-
*
|
|
9749
|
-
* @type {
|
|
10159
|
+
* Object for the configuration of the Workflow Run link.
|
|
10160
|
+
* @type {WorkflowRunLink}
|
|
9750
10161
|
* @memberof WorkflowRun
|
|
9751
10162
|
*/
|
|
9752
|
-
'link'?:
|
|
10163
|
+
'link'?: WorkflowRunLink;
|
|
9753
10164
|
/**
|
|
9754
10165
|
* The date and time when the Workflow Run was created.
|
|
9755
10166
|
* @type {string}
|
|
@@ -9782,10 +10193,10 @@ export interface WorkflowRun {
|
|
|
9782
10193
|
'dashboard_url'?: string;
|
|
9783
10194
|
/**
|
|
9784
10195
|
* The status of the Workflow Run.
|
|
9785
|
-
* @type {
|
|
10196
|
+
* @type {WorkflowRunStatus}
|
|
9786
10197
|
* @memberof WorkflowRun
|
|
9787
10198
|
*/
|
|
9788
|
-
'status'?:
|
|
10199
|
+
'status'?: WorkflowRunStatus;
|
|
9789
10200
|
/**
|
|
9790
10201
|
* Output object contains all of the properties configured on the Workflow version.
|
|
9791
10202
|
* @type {object}
|
|
@@ -9799,11 +10210,11 @@ export interface WorkflowRun {
|
|
|
9799
10210
|
*/
|
|
9800
10211
|
'reasons'?: Array<string>;
|
|
9801
10212
|
/**
|
|
9802
|
-
*
|
|
9803
|
-
* @type {
|
|
10213
|
+
* Error object. Only set when the Workflow Run status is \'error\'.
|
|
10214
|
+
* @type {WorkflowRunError}
|
|
9804
10215
|
* @memberof WorkflowRun
|
|
9805
10216
|
*/
|
|
9806
|
-
'error'?:
|
|
10217
|
+
'error'?: WorkflowRunError;
|
|
9807
10218
|
/**
|
|
9808
10219
|
* Client token to use when loading this workflow run in the Onfido SDK.
|
|
9809
10220
|
* @type {string}
|
|
@@ -9811,17 +10222,6 @@ export interface WorkflowRun {
|
|
|
9811
10222
|
*/
|
|
9812
10223
|
'sdk_token'?: string | null;
|
|
9813
10224
|
}
|
|
9814
|
-
export declare const WorkflowRunStatusEnum: {
|
|
9815
|
-
readonly AwaitingInput: "awaiting_input";
|
|
9816
|
-
readonly Processing: "processing";
|
|
9817
|
-
readonly Abandoned: "abandoned";
|
|
9818
|
-
readonly Error: "error";
|
|
9819
|
-
readonly Approved: "approved";
|
|
9820
|
-
readonly Review: "review";
|
|
9821
|
-
readonly Declined: "declined";
|
|
9822
|
-
readonly UnknownDefaultOpenApi: "11184809";
|
|
9823
|
-
};
|
|
9824
|
-
export type WorkflowRunStatusEnum = typeof WorkflowRunStatusEnum[keyof typeof WorkflowRunStatusEnum];
|
|
9825
10225
|
/**
|
|
9826
10226
|
*
|
|
9827
10227
|
* @export
|
|
@@ -9853,11 +10253,11 @@ export interface WorkflowRunBuilder {
|
|
|
9853
10253
|
*/
|
|
9854
10254
|
'customer_user_id'?: string;
|
|
9855
10255
|
/**
|
|
9856
|
-
*
|
|
9857
|
-
* @type {
|
|
10256
|
+
* Object for the configuration of the Workflow Run link.
|
|
10257
|
+
* @type {WorkflowRunLink}
|
|
9858
10258
|
* @memberof WorkflowRunBuilder
|
|
9859
10259
|
*/
|
|
9860
|
-
'link'?:
|
|
10260
|
+
'link'?: WorkflowRunLink;
|
|
9861
10261
|
/**
|
|
9862
10262
|
* The date and time when the Workflow Run was created.
|
|
9863
10263
|
* @type {string}
|
|
@@ -9879,6 +10279,73 @@ export interface WorkflowRunBuilder {
|
|
|
9879
10279
|
[key: string]: any;
|
|
9880
10280
|
};
|
|
9881
10281
|
}
|
|
10282
|
+
/**
|
|
10283
|
+
*
|
|
10284
|
+
* @export
|
|
10285
|
+
* @interface WorkflowRunError
|
|
10286
|
+
*/
|
|
10287
|
+
export interface WorkflowRunError {
|
|
10288
|
+
/**
|
|
10289
|
+
* The type of error.
|
|
10290
|
+
* @type {string}
|
|
10291
|
+
* @memberof WorkflowRunError
|
|
10292
|
+
*/
|
|
10293
|
+
'type'?: string;
|
|
10294
|
+
/**
|
|
10295
|
+
* A textual description of the error.
|
|
10296
|
+
* @type {string}
|
|
10297
|
+
* @memberof WorkflowRunError
|
|
10298
|
+
*/
|
|
10299
|
+
'message'?: string;
|
|
10300
|
+
}
|
|
10301
|
+
/**
|
|
10302
|
+
*
|
|
10303
|
+
* @export
|
|
10304
|
+
* @interface WorkflowRunLink
|
|
10305
|
+
*/
|
|
10306
|
+
export interface WorkflowRunLink {
|
|
10307
|
+
/**
|
|
10308
|
+
* Link to access the Workflow Run without the need to integrate with Onfido\'s SDKs.
|
|
10309
|
+
* @type {string}
|
|
10310
|
+
* @memberof WorkflowRunLink
|
|
10311
|
+
*/
|
|
10312
|
+
'url'?: string;
|
|
10313
|
+
/**
|
|
10314
|
+
* When the interactive section of the Workflow Run has completed successfully, the user will be redirected to this URL instead of seeing the default Onfido \'thank you\' page.
|
|
10315
|
+
* @type {string}
|
|
10316
|
+
* @memberof WorkflowRunLink
|
|
10317
|
+
*/
|
|
10318
|
+
'completed_redirect_url'?: string | null;
|
|
10319
|
+
/**
|
|
10320
|
+
* When the link has expired, the user will be immediately redirected to this URL instead of seeing the default Onfido error message.
|
|
10321
|
+
* @type {string}
|
|
10322
|
+
* @memberof WorkflowRunLink
|
|
10323
|
+
*/
|
|
10324
|
+
'expired_redirect_url'?: string | null;
|
|
10325
|
+
/**
|
|
10326
|
+
* Date and time when the link will expire.
|
|
10327
|
+
* @type {string}
|
|
10328
|
+
* @memberof WorkflowRunLink
|
|
10329
|
+
*/
|
|
10330
|
+
'expires_at'?: string | null;
|
|
10331
|
+
/**
|
|
10332
|
+
* The code for the language when the workflow run is acessed using the link.
|
|
10333
|
+
* @type {string}
|
|
10334
|
+
* @memberof WorkflowRunLink
|
|
10335
|
+
*/
|
|
10336
|
+
'language'?: WorkflowRunLinkLanguageEnum | null;
|
|
10337
|
+
}
|
|
10338
|
+
export declare const WorkflowRunLinkLanguageEnum: {
|
|
10339
|
+
readonly EnUs: "en_US";
|
|
10340
|
+
readonly DeDe: "de_DE";
|
|
10341
|
+
readonly EsEs: "es_ES";
|
|
10342
|
+
readonly FrFr: "fr_FR";
|
|
10343
|
+
readonly ItIt: "it_IT";
|
|
10344
|
+
readonly PtPt: "pt_PT";
|
|
10345
|
+
readonly NlNl: "nl_NL";
|
|
10346
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
10347
|
+
};
|
|
10348
|
+
export type WorkflowRunLinkLanguageEnum = typeof WorkflowRunLinkLanguageEnum[keyof typeof WorkflowRunLinkLanguageEnum];
|
|
9882
10349
|
/**
|
|
9883
10350
|
*
|
|
9884
10351
|
* @export
|
|
@@ -9920,10 +10387,10 @@ export interface WorkflowRunResponse {
|
|
|
9920
10387
|
'dashboard_url'?: string;
|
|
9921
10388
|
/**
|
|
9922
10389
|
* The status of the Workflow Run.
|
|
9923
|
-
* @type {
|
|
10390
|
+
* @type {WorkflowRunStatus}
|
|
9924
10391
|
* @memberof WorkflowRunResponse
|
|
9925
10392
|
*/
|
|
9926
|
-
'status'?:
|
|
10393
|
+
'status'?: WorkflowRunStatus;
|
|
9927
10394
|
/**
|
|
9928
10395
|
* Output object contains all of the properties configured on the Workflow version.
|
|
9929
10396
|
* @type {object}
|
|
@@ -9937,11 +10404,11 @@ export interface WorkflowRunResponse {
|
|
|
9937
10404
|
*/
|
|
9938
10405
|
'reasons'?: Array<string>;
|
|
9939
10406
|
/**
|
|
9940
|
-
*
|
|
9941
|
-
* @type {
|
|
10407
|
+
* Error object. Only set when the Workflow Run status is \'error\'.
|
|
10408
|
+
* @type {WorkflowRunError}
|
|
9942
10409
|
* @memberof WorkflowRunResponse
|
|
9943
10410
|
*/
|
|
9944
|
-
'error'?:
|
|
10411
|
+
'error'?: WorkflowRunError;
|
|
9945
10412
|
/**
|
|
9946
10413
|
* Client token to use when loading this workflow run in the Onfido SDK.
|
|
9947
10414
|
* @type {string}
|
|
@@ -9949,36 +10416,6 @@ export interface WorkflowRunResponse {
|
|
|
9949
10416
|
*/
|
|
9950
10417
|
'sdk_token'?: string | null;
|
|
9951
10418
|
}
|
|
9952
|
-
export declare const WorkflowRunResponseStatusEnum: {
|
|
9953
|
-
readonly AwaitingInput: "awaiting_input";
|
|
9954
|
-
readonly Processing: "processing";
|
|
9955
|
-
readonly Abandoned: "abandoned";
|
|
9956
|
-
readonly Error: "error";
|
|
9957
|
-
readonly Approved: "approved";
|
|
9958
|
-
readonly Review: "review";
|
|
9959
|
-
readonly Declined: "declined";
|
|
9960
|
-
readonly UnknownDefaultOpenApi: "11184809";
|
|
9961
|
-
};
|
|
9962
|
-
export type WorkflowRunResponseStatusEnum = typeof WorkflowRunResponseStatusEnum[keyof typeof WorkflowRunResponseStatusEnum];
|
|
9963
|
-
/**
|
|
9964
|
-
* Error object. Only set when the Workflow Run status is \'error\'.
|
|
9965
|
-
* @export
|
|
9966
|
-
* @interface WorkflowRunResponseError
|
|
9967
|
-
*/
|
|
9968
|
-
export interface WorkflowRunResponseError {
|
|
9969
|
-
/**
|
|
9970
|
-
* The type of error.
|
|
9971
|
-
* @type {string}
|
|
9972
|
-
* @memberof WorkflowRunResponseError
|
|
9973
|
-
*/
|
|
9974
|
-
'type'?: string;
|
|
9975
|
-
/**
|
|
9976
|
-
* A textual description of the error.
|
|
9977
|
-
* @type {string}
|
|
9978
|
-
* @memberof WorkflowRunResponseError
|
|
9979
|
-
*/
|
|
9980
|
-
'message'?: string;
|
|
9981
|
-
}
|
|
9982
10419
|
/**
|
|
9983
10420
|
*
|
|
9984
10421
|
* @export
|
|
@@ -10010,11 +10447,11 @@ export interface WorkflowRunShared {
|
|
|
10010
10447
|
*/
|
|
10011
10448
|
'customer_user_id'?: string;
|
|
10012
10449
|
/**
|
|
10013
|
-
*
|
|
10014
|
-
* @type {
|
|
10450
|
+
* Object for the configuration of the Workflow Run link.
|
|
10451
|
+
* @type {WorkflowRunLink}
|
|
10015
10452
|
* @memberof WorkflowRunShared
|
|
10016
10453
|
*/
|
|
10017
|
-
'link'?:
|
|
10454
|
+
'link'?: WorkflowRunLink;
|
|
10018
10455
|
/**
|
|
10019
10456
|
* The date and time when the Workflow Run was created.
|
|
10020
10457
|
* @type {string}
|
|
@@ -10029,53 +10466,22 @@ export interface WorkflowRunShared {
|
|
|
10029
10466
|
'updated_at'?: string;
|
|
10030
10467
|
}
|
|
10031
10468
|
/**
|
|
10032
|
-
*
|
|
10469
|
+
*
|
|
10033
10470
|
* @export
|
|
10034
|
-
* @
|
|
10471
|
+
* @enum {string}
|
|
10035
10472
|
*/
|
|
10036
|
-
export
|
|
10037
|
-
|
|
10038
|
-
|
|
10039
|
-
|
|
10040
|
-
|
|
10041
|
-
|
|
10042
|
-
|
|
10043
|
-
|
|
10044
|
-
|
|
10045
|
-
* @type {string}
|
|
10046
|
-
* @memberof WorkflowRunSharedLink
|
|
10047
|
-
*/
|
|
10048
|
-
'completed_redirect_url'?: string;
|
|
10049
|
-
/**
|
|
10050
|
-
* When the link has expired, the user will be immediately redirected to this URL instead of seeing the default Onfido error message.
|
|
10051
|
-
* @type {string}
|
|
10052
|
-
* @memberof WorkflowRunSharedLink
|
|
10053
|
-
*/
|
|
10054
|
-
'expired_redirect_url'?: string;
|
|
10055
|
-
/**
|
|
10056
|
-
* Date and time when the link will expire.
|
|
10057
|
-
* @type {string}
|
|
10058
|
-
* @memberof WorkflowRunSharedLink
|
|
10059
|
-
*/
|
|
10060
|
-
'expires_at'?: string;
|
|
10061
|
-
/**
|
|
10062
|
-
* The code for the language when the workflow run is acessed using the link.
|
|
10063
|
-
* @type {string}
|
|
10064
|
-
* @memberof WorkflowRunSharedLink
|
|
10065
|
-
*/
|
|
10066
|
-
'language'?: WorkflowRunSharedLinkLanguageEnum;
|
|
10067
|
-
}
|
|
10068
|
-
export declare const WorkflowRunSharedLinkLanguageEnum: {
|
|
10069
|
-
readonly EnUs: "en_US";
|
|
10070
|
-
readonly DeDe: "de_DE";
|
|
10071
|
-
readonly EsEs: "es_ES";
|
|
10072
|
-
readonly FrFr: "fr_FR";
|
|
10073
|
-
readonly ItIt: "it_IT";
|
|
10074
|
-
readonly PtPt: "pt_PT";
|
|
10075
|
-
readonly NlNl: "nl_NL";
|
|
10473
|
+
export declare const WorkflowRunStatus: {
|
|
10474
|
+
readonly Processing: "processing";
|
|
10475
|
+
readonly AwaitingInput: "awaiting_input";
|
|
10476
|
+
readonly AwaitingClientInput: "awaiting_client_input";
|
|
10477
|
+
readonly Approved: "approved";
|
|
10478
|
+
readonly Declined: "declined";
|
|
10479
|
+
readonly Review: "review";
|
|
10480
|
+
readonly Abandoned: "abandoned";
|
|
10481
|
+
readonly Error: "error";
|
|
10076
10482
|
readonly UnknownDefaultOpenApi: "11184809";
|
|
10077
10483
|
};
|
|
10078
|
-
export type
|
|
10484
|
+
export type WorkflowRunStatus = typeof WorkflowRunStatus[keyof typeof WorkflowRunStatus];
|
|
10079
10485
|
/**
|
|
10080
10486
|
* DefaultApi - axios parameter creator
|
|
10081
10487
|
* @export
|
|
@@ -10593,7 +10999,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
10593
10999
|
/**
|
|
10594
11000
|
* Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
|
|
10595
11001
|
* @summary Upload a document
|
|
10596
|
-
* @param {
|
|
11002
|
+
* @param {DocumentTypes} type The type of document
|
|
10597
11003
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
10598
11004
|
* @param {FileTransfer} file The file to be uploaded.
|
|
10599
11005
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
@@ -10604,7 +11010,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
10604
11010
|
* @param {*} [options] Override http request option.
|
|
10605
11011
|
* @throws {RequiredError}
|
|
10606
11012
|
*/
|
|
10607
|
-
uploadDocument: (type:
|
|
11013
|
+
uploadDocument: (type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10608
11014
|
/**
|
|
10609
11015
|
* 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.
|
|
10610
11016
|
* @summary Upload ID photo
|
|
@@ -11142,7 +11548,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
11142
11548
|
/**
|
|
11143
11549
|
* Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
|
|
11144
11550
|
* @summary Upload a document
|
|
11145
|
-
* @param {
|
|
11551
|
+
* @param {DocumentTypes} type The type of document
|
|
11146
11552
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
11147
11553
|
* @param {FileTransfer} file The file to be uploaded.
|
|
11148
11554
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
@@ -11153,7 +11559,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
11153
11559
|
* @param {*} [options] Override http request option.
|
|
11154
11560
|
* @throws {RequiredError}
|
|
11155
11561
|
*/
|
|
11156
|
-
uploadDocument(type:
|
|
11562
|
+
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>>;
|
|
11157
11563
|
/**
|
|
11158
11564
|
* 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.
|
|
11159
11565
|
* @summary Upload ID photo
|
|
@@ -11186,7 +11592,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11186
11592
|
* @param {*} [options] Override http request option.
|
|
11187
11593
|
* @throws {RequiredError}
|
|
11188
11594
|
*/
|
|
11189
|
-
cancelReport(reportId: string, options?:
|
|
11595
|
+
cancelReport(reportId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11190
11596
|
/**
|
|
11191
11597
|
* Completes a Send / Receive Data Task.
|
|
11192
11598
|
* @summary Complete Task
|
|
@@ -11196,7 +11602,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11196
11602
|
* @param {*} [options] Override http request option.
|
|
11197
11603
|
* @throws {RequiredError}
|
|
11198
11604
|
*/
|
|
11199
|
-
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?:
|
|
11605
|
+
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11200
11606
|
/**
|
|
11201
11607
|
* Creates a single applicant. Returns an applicant object.
|
|
11202
11608
|
* @summary Create Applicant
|
|
@@ -11204,7 +11610,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11204
11610
|
* @param {*} [options] Override http request option.
|
|
11205
11611
|
* @throws {RequiredError}
|
|
11206
11612
|
*/
|
|
11207
|
-
createApplicant(applicantBuilder: ApplicantBuilder, options?:
|
|
11613
|
+
createApplicant(applicantBuilder: ApplicantBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Applicant>;
|
|
11208
11614
|
/**
|
|
11209
11615
|
* Initiates a check for an applicant, which can contain one or more reports. Returns a check object.
|
|
11210
11616
|
* @summary Create a check
|
|
@@ -11212,7 +11618,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11212
11618
|
* @param {*} [options] Override http request option.
|
|
11213
11619
|
* @throws {RequiredError}
|
|
11214
11620
|
*/
|
|
11215
|
-
createCheck(checkBuilder: CheckBuilder, options?:
|
|
11621
|
+
createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Check>;
|
|
11216
11622
|
/**
|
|
11217
11623
|
* Triggers the generation of the Timeline File for the designated Workflow Run.
|
|
11218
11624
|
* @summary Create Timeline File for Workflow Run
|
|
@@ -11220,7 +11626,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11220
11626
|
* @param {*} [options] Override http request option.
|
|
11221
11627
|
* @throws {RequiredError}
|
|
11222
11628
|
*/
|
|
11223
|
-
createTimelineFile(workflowRunId: string, options?:
|
|
11629
|
+
createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<TimelineFileReference>;
|
|
11224
11630
|
/**
|
|
11225
11631
|
* Creates a new monitor for the applicant
|
|
11226
11632
|
* @summary Create monitor
|
|
@@ -11228,7 +11634,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11228
11634
|
* @param {*} [options] Override http request option.
|
|
11229
11635
|
* @throws {RequiredError}
|
|
11230
11636
|
*/
|
|
11231
|
-
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?:
|
|
11637
|
+
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): AxiosPromise<WatchlistMonitor>;
|
|
11232
11638
|
/**
|
|
11233
11639
|
* Registers a webhook. Returns a webhook object.
|
|
11234
11640
|
* @summary Register webhook
|
|
@@ -11236,7 +11642,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11236
11642
|
* @param {*} [options] Override http request option.
|
|
11237
11643
|
* @throws {RequiredError}
|
|
11238
11644
|
*/
|
|
11239
|
-
createWebhook(webhookBuilder: WebhookBuilder, options?:
|
|
11645
|
+
createWebhook(webhookBuilder: WebhookBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Webhook>;
|
|
11240
11646
|
/**
|
|
11241
11647
|
* Creates and starts a Workflow Run. Returns a Workflow Run object.
|
|
11242
11648
|
* @summary Create a Workflow Run
|
|
@@ -11244,7 +11650,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11244
11650
|
* @param {*} [options] Override http request option.
|
|
11245
11651
|
* @throws {RequiredError}
|
|
11246
11652
|
*/
|
|
11247
|
-
createWorkflowRun(workflowRunBuilder: WorkflowRunBuilder, options?:
|
|
11653
|
+
createWorkflowRun(workflowRunBuilder: WorkflowRunBuilder, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRun>;
|
|
11248
11654
|
/**
|
|
11249
11655
|
* Deletes a single applicant.
|
|
11250
11656
|
* @summary Delete Applicant
|
|
@@ -11252,7 +11658,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11252
11658
|
* @param {*} [options] Override http request option.
|
|
11253
11659
|
* @throws {RequiredError}
|
|
11254
11660
|
*/
|
|
11255
|
-
deleteApplicant(applicantId: string, options?:
|
|
11661
|
+
deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11256
11662
|
/**
|
|
11257
11663
|
* Deactivates the given monitor
|
|
11258
11664
|
* @summary Delete monitor
|
|
@@ -11260,7 +11666,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11260
11666
|
* @param {*} [options] Override http request option.
|
|
11261
11667
|
* @throws {RequiredError}
|
|
11262
11668
|
*/
|
|
11263
|
-
deleteWatchlistMonitor(monitorId: string, options?:
|
|
11669
|
+
deleteWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11264
11670
|
/**
|
|
11265
11671
|
* Deletes a webhook.
|
|
11266
11672
|
* @summary Delete a webhook
|
|
@@ -11268,7 +11674,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11268
11674
|
* @param {*} [options] Override http request option.
|
|
11269
11675
|
* @throws {RequiredError}
|
|
11270
11676
|
*/
|
|
11271
|
-
deleteWebhook(webhookId: string, options?:
|
|
11677
|
+
deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11272
11678
|
/**
|
|
11273
11679
|
* Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
|
|
11274
11680
|
* @summary Download check
|
|
@@ -11276,7 +11682,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11276
11682
|
* @param {*} [options] Override http request option.
|
|
11277
11683
|
* @throws {RequiredError}
|
|
11278
11684
|
*/
|
|
11279
|
-
downloadCheck(checkId: string, options?:
|
|
11685
|
+
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11280
11686
|
/**
|
|
11281
11687
|
* Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
|
11282
11688
|
* @summary Download document
|
|
@@ -11284,7 +11690,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11284
11690
|
* @param {*} [options] Override http request option.
|
|
11285
11691
|
* @throws {RequiredError}
|
|
11286
11692
|
*/
|
|
11287
|
-
downloadDocument(documentId: string, options?:
|
|
11693
|
+
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11288
11694
|
/**
|
|
11289
11695
|
* Downloads a document video. If successful, the response will be the binary data representing the video.
|
|
11290
11696
|
* @summary Download document video
|
|
@@ -11292,7 +11698,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11292
11698
|
* @param {*} [options] Override http request option.
|
|
11293
11699
|
* @throws {RequiredError}
|
|
11294
11700
|
*/
|
|
11295
|
-
downloadDocumentVideo(documentId: string, options?:
|
|
11701
|
+
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11296
11702
|
/**
|
|
11297
11703
|
* ID photos are downloaded using this endpoint.
|
|
11298
11704
|
* @summary Download ID photo
|
|
@@ -11300,7 +11706,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11300
11706
|
* @param {*} [options] Override http request option.
|
|
11301
11707
|
* @throws {RequiredError}
|
|
11302
11708
|
*/
|
|
11303
|
-
downloadIdPhoto(idPhotoId: string, options?:
|
|
11709
|
+
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11304
11710
|
/**
|
|
11305
11711
|
* Live photos are downloaded using this endpoint.
|
|
11306
11712
|
* @summary Download live photo
|
|
@@ -11308,7 +11714,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11308
11714
|
* @param {*} [options] Override http request option.
|
|
11309
11715
|
* @throws {RequiredError}
|
|
11310
11716
|
*/
|
|
11311
|
-
downloadLivePhoto(livePhotoId: string, options?:
|
|
11717
|
+
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11312
11718
|
/**
|
|
11313
11719
|
* Live videos are downloaded using this endpoint.
|
|
11314
11720
|
* @summary Download live video
|
|
@@ -11316,7 +11722,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11316
11722
|
* @param {*} [options] Override http request option.
|
|
11317
11723
|
* @throws {RequiredError}
|
|
11318
11724
|
*/
|
|
11319
|
-
downloadLiveVideo(liveVideoId: string, options?:
|
|
11725
|
+
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11320
11726
|
/**
|
|
11321
11727
|
* Returns the binary data representing a single frame from a live video.
|
|
11322
11728
|
* @summary Download live video frame
|
|
@@ -11324,7 +11730,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11324
11730
|
* @param {*} [options] Override http request option.
|
|
11325
11731
|
* @throws {RequiredError}
|
|
11326
11732
|
*/
|
|
11327
|
-
downloadLiveVideoFrame(liveVideoId: string, options?:
|
|
11733
|
+
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11328
11734
|
/**
|
|
11329
11735
|
* Motion captures are downloaded using this endpoint.
|
|
11330
11736
|
* @summary Download motion capture
|
|
@@ -11332,7 +11738,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11332
11738
|
* @param {*} [options] Override http request option.
|
|
11333
11739
|
* @throws {RequiredError}
|
|
11334
11740
|
*/
|
|
11335
|
-
downloadMotionCapture(motionCaptureId: string, options?:
|
|
11741
|
+
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11336
11742
|
/**
|
|
11337
11743
|
* Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
|
|
11338
11744
|
* @summary Download motion capture frame
|
|
@@ -11340,7 +11746,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11340
11746
|
* @param {*} [options] Override http request option.
|
|
11341
11747
|
* @throws {RequiredError}
|
|
11342
11748
|
*/
|
|
11343
|
-
downloadMotionCaptureFrame(motionCaptureId: string, options?:
|
|
11749
|
+
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11344
11750
|
/**
|
|
11345
11751
|
* Retrieves the signed document or application form depending on the file_id provided.
|
|
11346
11752
|
* @summary Retrieves the signed document or application form
|
|
@@ -11349,7 +11755,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11349
11755
|
* @param {*} [options] Override http request option.
|
|
11350
11756
|
* @throws {RequiredError}
|
|
11351
11757
|
*/
|
|
11352
|
-
downloadQesDocument(workflowRunId: string, fileId: string, options?:
|
|
11758
|
+
downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11353
11759
|
/**
|
|
11354
11760
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
11355
11761
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -11357,7 +11763,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11357
11763
|
* @param {*} [options] Override http request option.
|
|
11358
11764
|
* @throws {RequiredError}
|
|
11359
11765
|
*/
|
|
11360
|
-
downloadSignedEvidenceFile(workflowRunId: string, options?:
|
|
11766
|
+
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11361
11767
|
/**
|
|
11362
11768
|
* Extract information from a document
|
|
11363
11769
|
* @summary Autofill
|
|
@@ -11365,7 +11771,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11365
11771
|
* @param {*} [options] Override http request option.
|
|
11366
11772
|
* @throws {RequiredError}
|
|
11367
11773
|
*/
|
|
11368
|
-
extract(extractRequest: ExtractRequest, options?:
|
|
11774
|
+
extract(extractRequest: ExtractRequest, options?: RawAxiosRequestConfig): AxiosPromise<Extraction>;
|
|
11369
11775
|
/**
|
|
11370
11776
|
* Search for addresses by postcode
|
|
11371
11777
|
* @summary Address Picker
|
|
@@ -11373,7 +11779,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11373
11779
|
* @param {*} [options] Override http request option.
|
|
11374
11780
|
* @throws {RequiredError}
|
|
11375
11781
|
*/
|
|
11376
|
-
findAddresses(postcode: string, options?:
|
|
11782
|
+
findAddresses(postcode: string, options?: RawAxiosRequestConfig): AxiosPromise<AddressesList>;
|
|
11377
11783
|
/**
|
|
11378
11784
|
* Retrieves a single applicant. Returns an applicant object.
|
|
11379
11785
|
* @summary Retrieve Applicant
|
|
@@ -11381,7 +11787,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11381
11787
|
* @param {*} [options] Override http request option.
|
|
11382
11788
|
* @throws {RequiredError}
|
|
11383
11789
|
*/
|
|
11384
|
-
findApplicant(applicantId: string, options?:
|
|
11790
|
+
findApplicant(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<Applicant>;
|
|
11385
11791
|
/**
|
|
11386
11792
|
* Retrieves a single check. Returns a check object.
|
|
11387
11793
|
* @summary Retrieve a Check
|
|
@@ -11389,7 +11795,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11389
11795
|
* @param {*} [options] Override http request option.
|
|
11390
11796
|
* @throws {RequiredError}
|
|
11391
11797
|
*/
|
|
11392
|
-
findCheck(checkId: string, options?:
|
|
11798
|
+
findCheck(checkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Check>;
|
|
11393
11799
|
/**
|
|
11394
11800
|
* A single document can be retrieved by calling this endpoint with the document\'s unique identifier.
|
|
11395
11801
|
* @summary Retrieve document
|
|
@@ -11397,7 +11803,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11397
11803
|
* @param {*} [options] Override http request option.
|
|
11398
11804
|
* @throws {RequiredError}
|
|
11399
11805
|
*/
|
|
11400
|
-
findDocument(documentId: string, options?:
|
|
11806
|
+
findDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<Document>;
|
|
11401
11807
|
/**
|
|
11402
11808
|
* Retrieves a single ID photo. Returns a ID photo object.
|
|
11403
11809
|
* @summary Retrieve ID photo
|
|
@@ -11405,7 +11811,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11405
11811
|
* @param {*} [options] Override http request option.
|
|
11406
11812
|
* @throws {RequiredError}
|
|
11407
11813
|
*/
|
|
11408
|
-
findIdPhoto(idPhotoId: string, options?:
|
|
11814
|
+
findIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): AxiosPromise<IdPhoto>;
|
|
11409
11815
|
/**
|
|
11410
11816
|
* Retrieves a single live photo. Returns a live photo object.
|
|
11411
11817
|
* @summary Retrieve live photo
|
|
@@ -11413,7 +11819,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11413
11819
|
* @param {*} [options] Override http request option.
|
|
11414
11820
|
* @throws {RequiredError}
|
|
11415
11821
|
*/
|
|
11416
|
-
findLivePhoto(livePhotoId: string, options?:
|
|
11822
|
+
findLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): AxiosPromise<LivePhoto>;
|
|
11417
11823
|
/**
|
|
11418
11824
|
* Retrieves a single live video. Returns the corresponding live video object.
|
|
11419
11825
|
* @summary Retrieve live video
|
|
@@ -11421,7 +11827,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11421
11827
|
* @param {*} [options] Override http request option.
|
|
11422
11828
|
* @throws {RequiredError}
|
|
11423
11829
|
*/
|
|
11424
|
-
findLiveVideo(liveVideoId: string, options?:
|
|
11830
|
+
findLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): AxiosPromise<LiveVideo>;
|
|
11425
11831
|
/**
|
|
11426
11832
|
* Retrieves a single motion capture. Returns the corresponding motion capture object.
|
|
11427
11833
|
* @summary Retrieve motion capture
|
|
@@ -11429,7 +11835,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11429
11835
|
* @param {*} [options] Override http request option.
|
|
11430
11836
|
* @throws {RequiredError}
|
|
11431
11837
|
*/
|
|
11432
|
-
findMotionCapture(motionCaptureId: string, options?:
|
|
11838
|
+
findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionCapture>;
|
|
11433
11839
|
/**
|
|
11434
11840
|
* A single report can be retrieved using this endpoint with the corresponding unique identifier.
|
|
11435
11841
|
* @summary Retrieve report
|
|
@@ -11437,7 +11843,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11437
11843
|
* @param {*} [options] Override http request option.
|
|
11438
11844
|
* @throws {RequiredError}
|
|
11439
11845
|
*/
|
|
11440
|
-
findReport(reportId: string, options?:
|
|
11846
|
+
findReport(reportId: string, options?: RawAxiosRequestConfig): AxiosPromise<Report>;
|
|
11441
11847
|
/**
|
|
11442
11848
|
* A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
|
|
11443
11849
|
* @summary Retrieve Task
|
|
@@ -11446,7 +11852,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11446
11852
|
* @param {*} [options] Override http request option.
|
|
11447
11853
|
* @throws {RequiredError}
|
|
11448
11854
|
*/
|
|
11449
|
-
findTask(workflowRunId: string, taskId: string, options?:
|
|
11855
|
+
findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<Task>;
|
|
11450
11856
|
/**
|
|
11451
11857
|
* Retrieves the Timeline File for the designated Workflow Run.
|
|
11452
11858
|
* @summary Retrieve Timeline File for Workflow Run
|
|
@@ -11455,7 +11861,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11455
11861
|
* @param {*} [options] Override http request option.
|
|
11456
11862
|
* @throws {RequiredError}
|
|
11457
11863
|
*/
|
|
11458
|
-
findTimelineFile(workflowRunId: string, timelineFileId: string, options?:
|
|
11864
|
+
findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
|
|
11459
11865
|
/**
|
|
11460
11866
|
* Retrieves a single monitor
|
|
11461
11867
|
* @summary Retrieve monitor
|
|
@@ -11463,7 +11869,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11463
11869
|
* @param {*} [options] Override http request option.
|
|
11464
11870
|
* @throws {RequiredError}
|
|
11465
11871
|
*/
|
|
11466
|
-
findWatchlistMonitor(monitorId: string, options?:
|
|
11872
|
+
findWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): AxiosPromise<WatchlistMonitor>;
|
|
11467
11873
|
/**
|
|
11468
11874
|
* Retrieves a single webhook. Returns a webhook object.
|
|
11469
11875
|
* @summary Retrieve a Webhook
|
|
@@ -11471,7 +11877,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11471
11877
|
* @param {*} [options] Override http request option.
|
|
11472
11878
|
* @throws {RequiredError}
|
|
11473
11879
|
*/
|
|
11474
|
-
findWebhook(webhookId: string, options?:
|
|
11880
|
+
findWebhook(webhookId: string, options?: RawAxiosRequestConfig): AxiosPromise<Webhook>;
|
|
11475
11881
|
/**
|
|
11476
11882
|
* A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
|
11477
11883
|
* @summary Retrieve Workflow Run
|
|
@@ -11479,7 +11885,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11479
11885
|
* @param {*} [options] Override http request option.
|
|
11480
11886
|
* @throws {RequiredError}
|
|
11481
11887
|
*/
|
|
11482
|
-
findWorkflowRun(workflowRunId: string, options?:
|
|
11888
|
+
findWorkflowRun(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRun>;
|
|
11483
11889
|
/**
|
|
11484
11890
|
* Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
|
|
11485
11891
|
* @summary Force new report creation (BETA)
|
|
@@ -11487,7 +11893,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11487
11893
|
* @param {*} [options] Override http request option.
|
|
11488
11894
|
* @throws {RequiredError}
|
|
11489
11895
|
*/
|
|
11490
|
-
forceReportCreationFromWatchlistMonitor(monitorId: string, options?:
|
|
11896
|
+
forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11491
11897
|
/**
|
|
11492
11898
|
* Generates an SDK token. Returns a token object containing the SDK token.
|
|
11493
11899
|
* @summary Generate a SDK token
|
|
@@ -11495,7 +11901,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11495
11901
|
* @param {*} [options] Override http request option.
|
|
11496
11902
|
* @throws {RequiredError}
|
|
11497
11903
|
*/
|
|
11498
|
-
generateSdkToken(sdkTokenBuilder: SdkTokenBuilder, options?:
|
|
11904
|
+
generateSdkToken(sdkTokenBuilder: SdkTokenBuilder, options?: RawAxiosRequestConfig): AxiosPromise<SdkToken>;
|
|
11499
11905
|
/**
|
|
11500
11906
|
* Lists all applicants you\'ve created, sorted by creation date in descending order.
|
|
11501
11907
|
* @summary List Applicants
|
|
@@ -11505,7 +11911,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11505
11911
|
* @param {*} [options] Override http request option.
|
|
11506
11912
|
* @throws {RequiredError}
|
|
11507
11913
|
*/
|
|
11508
|
-
listApplicants(page?: number, perPage?: number, includeDeleted?: boolean, options?:
|
|
11914
|
+
listApplicants(page?: number, perPage?: number, includeDeleted?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ApplicantsList>;
|
|
11509
11915
|
/**
|
|
11510
11916
|
* Retrieves a single check. Returns a check object.
|
|
11511
11917
|
* @summary Retrieve Checks
|
|
@@ -11513,7 +11919,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11513
11919
|
* @param {*} [options] Override http request option.
|
|
11514
11920
|
* @throws {RequiredError}
|
|
11515
11921
|
*/
|
|
11516
|
-
listChecks(applicantId: string, options?:
|
|
11922
|
+
listChecks(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<ChecksList>;
|
|
11517
11923
|
/**
|
|
11518
11924
|
* All documents belonging to an applicant can be listed from this endpoint
|
|
11519
11925
|
* @summary List documents
|
|
@@ -11521,7 +11927,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11521
11927
|
* @param {*} [options] Override http request option.
|
|
11522
11928
|
* @throws {RequiredError}
|
|
11523
11929
|
*/
|
|
11524
|
-
listDocuments(applicantId: string, options?:
|
|
11930
|
+
listDocuments(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentsList>;
|
|
11525
11931
|
/**
|
|
11526
11932
|
* Lists the ID photos that belong to an applicant.
|
|
11527
11933
|
* @summary List ID photos
|
|
@@ -11529,7 +11935,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11529
11935
|
* @param {*} [options] Override http request option.
|
|
11530
11936
|
* @throws {RequiredError}
|
|
11531
11937
|
*/
|
|
11532
|
-
listIdPhotos(applicantId: string, options?:
|
|
11938
|
+
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<IdPhotosList>;
|
|
11533
11939
|
/**
|
|
11534
11940
|
* Lists the live photos that belong to an applicant.
|
|
11535
11941
|
* @summary List live photos
|
|
@@ -11537,7 +11943,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11537
11943
|
* @param {*} [options] Override http request option.
|
|
11538
11944
|
* @throws {RequiredError}
|
|
11539
11945
|
*/
|
|
11540
|
-
listLivePhotos(applicantId: string, options?:
|
|
11946
|
+
listLivePhotos(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<LivePhotosList>;
|
|
11541
11947
|
/**
|
|
11542
11948
|
* Lists all the live videos that belong to an applicant.
|
|
11543
11949
|
* @summary List live videos
|
|
@@ -11545,7 +11951,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11545
11951
|
* @param {*} [options] Override http request option.
|
|
11546
11952
|
* @throws {RequiredError}
|
|
11547
11953
|
*/
|
|
11548
|
-
listLiveVideos(applicantId: string, options?:
|
|
11954
|
+
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<LiveVideosList>;
|
|
11549
11955
|
/**
|
|
11550
11956
|
* Lists all the motion captures that belong to an applicant.
|
|
11551
11957
|
* @summary List motion captures
|
|
@@ -11553,7 +11959,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11553
11959
|
* @param {*} [options] Override http request option.
|
|
11554
11960
|
* @throws {RequiredError}
|
|
11555
11961
|
*/
|
|
11556
|
-
listMotionCaptures(applicantId: string, options?:
|
|
11962
|
+
listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionCapturesList>;
|
|
11557
11963
|
/**
|
|
11558
11964
|
* Returns all repeat attempts for a given Document report
|
|
11559
11965
|
* @summary Retrieve repeat attempts
|
|
@@ -11561,7 +11967,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11561
11967
|
* @param {*} [options] Override http request option.
|
|
11562
11968
|
* @throws {RequiredError}
|
|
11563
11969
|
*/
|
|
11564
|
-
listRepeatAttempts(reportId: string, options?:
|
|
11970
|
+
listRepeatAttempts(reportId: string, options?: RawAxiosRequestConfig): AxiosPromise<RepeatAttemptsList>;
|
|
11565
11971
|
/**
|
|
11566
11972
|
* All the reports belonging to a particular check can be listed from this endpoint.
|
|
11567
11973
|
* @summary List reports
|
|
@@ -11569,7 +11975,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11569
11975
|
* @param {*} [options] Override http request option.
|
|
11570
11976
|
* @throws {RequiredError}
|
|
11571
11977
|
*/
|
|
11572
|
-
listReports(checkId: string, options?:
|
|
11978
|
+
listReports(checkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReportsList>;
|
|
11573
11979
|
/**
|
|
11574
11980
|
* The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
|
11575
11981
|
* @summary List Tasks
|
|
@@ -11577,7 +11983,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11577
11983
|
* @param {*} [options] Override http request option.
|
|
11578
11984
|
* @throws {RequiredError}
|
|
11579
11985
|
*/
|
|
11580
|
-
listTasks(workflowRunId: string, options?:
|
|
11986
|
+
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<TaskItem>>;
|
|
11581
11987
|
/**
|
|
11582
11988
|
* List match IDs on this monitor, as well as their enabled/disabled status
|
|
11583
11989
|
* @summary List matches (BETA)
|
|
@@ -11585,7 +11991,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11585
11991
|
* @param {*} [options] Override http request option.
|
|
11586
11992
|
* @throws {RequiredError}
|
|
11587
11993
|
*/
|
|
11588
|
-
listWatchlistMonitorMatches(monitorId: string, options?:
|
|
11994
|
+
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): AxiosPromise<WatchlistMonitorMatchesList>;
|
|
11589
11995
|
/**
|
|
11590
11996
|
* List all available monitors for an applicant
|
|
11591
11997
|
* @summary List monitors
|
|
@@ -11594,14 +12000,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11594
12000
|
* @param {*} [options] Override http request option.
|
|
11595
12001
|
* @throws {RequiredError}
|
|
11596
12002
|
*/
|
|
11597
|
-
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?:
|
|
12003
|
+
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<WatchlistMonitorsList>;
|
|
11598
12004
|
/**
|
|
11599
12005
|
* Lists all webhooks you\'ve created.
|
|
11600
12006
|
* @summary List webhooks
|
|
11601
12007
|
* @param {*} [options] Override http request option.
|
|
11602
12008
|
* @throws {RequiredError}
|
|
11603
12009
|
*/
|
|
11604
|
-
listWebhooks(options?:
|
|
12010
|
+
listWebhooks(options?: RawAxiosRequestConfig): AxiosPromise<WebhooksList>;
|
|
11605
12011
|
/**
|
|
11606
12012
|
* Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.
|
|
11607
12013
|
* @summary List Workflow Runs
|
|
@@ -11613,14 +12019,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11613
12019
|
* @param {*} [options] Override http request option.
|
|
11614
12020
|
* @throws {RequiredError}
|
|
11615
12021
|
*/
|
|
11616
|
-
listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, options?:
|
|
12022
|
+
listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowRun>>;
|
|
11617
12023
|
/**
|
|
11618
12024
|
* Run a health check on the Onfido API
|
|
11619
12025
|
* @summary Ping
|
|
11620
12026
|
* @param {*} [options] Override http request option.
|
|
11621
12027
|
* @throws {RequiredError}
|
|
11622
12028
|
*/
|
|
11623
|
-
ping(options?:
|
|
12029
|
+
ping(options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
11624
12030
|
/**
|
|
11625
12031
|
* Create Feedback on checks and reports
|
|
11626
12032
|
* @summary Fraud reporting (ALPHA)
|
|
@@ -11628,7 +12034,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11628
12034
|
* @param {*} [options] Override http request option.
|
|
11629
12035
|
* @throws {RequiredError}
|
|
11630
12036
|
*/
|
|
11631
|
-
postResultsFeedback(resultsFeedback: ResultsFeedback, options?:
|
|
12037
|
+
postResultsFeedback(resultsFeedback: ResultsFeedback, options?: RawAxiosRequestConfig): AxiosPromise<ResultsFeedback>;
|
|
11632
12038
|
/**
|
|
11633
12039
|
* Resends events to all webhooks registered with a matching environment in your account.
|
|
11634
12040
|
* @summary Resends webhooks
|
|
@@ -11636,7 +12042,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11636
12042
|
* @param {*} [options] Override http request option.
|
|
11637
12043
|
* @throws {RequiredError}
|
|
11638
12044
|
*/
|
|
11639
|
-
resendWebhooks(webhookResend: WebhookResend, options?:
|
|
12045
|
+
resendWebhooks(webhookResend: WebhookResend, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11640
12046
|
/**
|
|
11641
12047
|
* Restores a single applicant scheduled for deletion.
|
|
11642
12048
|
* @summary Restore Applicant
|
|
@@ -11644,7 +12050,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11644
12050
|
* @param {*} [options] Override http request option.
|
|
11645
12051
|
* @throws {RequiredError}
|
|
11646
12052
|
*/
|
|
11647
|
-
restoreApplicant(applicantId: string, options?:
|
|
12053
|
+
restoreApplicant(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11648
12054
|
/**
|
|
11649
12055
|
* Resumes a paused check.
|
|
11650
12056
|
* @summary Resume a Check
|
|
@@ -11652,7 +12058,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11652
12058
|
* @param {*} [options] Override http request option.
|
|
11653
12059
|
* @throws {RequiredError}
|
|
11654
12060
|
*/
|
|
11655
|
-
resumeCheck(checkId: string, options?:
|
|
12061
|
+
resumeCheck(checkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11656
12062
|
/**
|
|
11657
12063
|
* Resumes a single paused report.
|
|
11658
12064
|
* @summary Resume report
|
|
@@ -11660,7 +12066,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11660
12066
|
* @param {*} [options] Override http request option.
|
|
11661
12067
|
* @throws {RequiredError}
|
|
11662
12068
|
*/
|
|
11663
|
-
resumeReport(reportId: string, options?:
|
|
12069
|
+
resumeReport(reportId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11664
12070
|
/**
|
|
11665
12071
|
* Allows updating applicant\'s information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant
|
|
11666
12072
|
* @summary Update Applicant
|
|
@@ -11669,7 +12075,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11669
12075
|
* @param {*} [options] Override http request option.
|
|
11670
12076
|
* @throws {RequiredError}
|
|
11671
12077
|
*/
|
|
11672
|
-
updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?:
|
|
12078
|
+
updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): AxiosPromise<Applicant>;
|
|
11673
12079
|
/**
|
|
11674
12080
|
* Update the status of the given matches
|
|
11675
12081
|
* @summary Set match status (BETA)
|
|
@@ -11678,7 +12084,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11678
12084
|
* @param {*} [options] Override http request option.
|
|
11679
12085
|
* @throws {RequiredError}
|
|
11680
12086
|
*/
|
|
11681
|
-
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?:
|
|
12087
|
+
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): AxiosPromise<WatchlistMonitorMatchesList>;
|
|
11682
12088
|
/**
|
|
11683
12089
|
* Edits a webhook. Returns the updated webhook object.
|
|
11684
12090
|
* @summary Edit a webhook
|
|
@@ -11687,11 +12093,11 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11687
12093
|
* @param {*} [options] Override http request option.
|
|
11688
12094
|
* @throws {RequiredError}
|
|
11689
12095
|
*/
|
|
11690
|
-
updateWebhook(webhookId: string, webhookUpdater: WebhookUpdater, options?:
|
|
12096
|
+
updateWebhook(webhookId: string, webhookUpdater: WebhookUpdater, options?: RawAxiosRequestConfig): AxiosPromise<Webhook>;
|
|
11691
12097
|
/**
|
|
11692
12098
|
* Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
|
|
11693
12099
|
* @summary Upload a document
|
|
11694
|
-
* @param {
|
|
12100
|
+
* @param {DocumentTypes} type The type of document
|
|
11695
12101
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
11696
12102
|
* @param {FileTransfer} file The file to be uploaded.
|
|
11697
12103
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
@@ -11702,7 +12108,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11702
12108
|
* @param {*} [options] Override http request option.
|
|
11703
12109
|
* @throws {RequiredError}
|
|
11704
12110
|
*/
|
|
11705
|
-
uploadDocument(type:
|
|
12111
|
+
uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Document>;
|
|
11706
12112
|
/**
|
|
11707
12113
|
* 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.
|
|
11708
12114
|
* @summary Upload ID photo
|
|
@@ -11711,7 +12117,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11711
12117
|
* @param {*} [options] Override http request option.
|
|
11712
12118
|
* @throws {RequiredError}
|
|
11713
12119
|
*/
|
|
11714
|
-
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?:
|
|
12120
|
+
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): AxiosPromise<IdPhoto>;
|
|
11715
12121
|
/**
|
|
11716
12122
|
* You can upload live 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. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
|
|
11717
12123
|
* @summary Upload live photo
|
|
@@ -11721,7 +12127,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11721
12127
|
* @param {*} [options] Override http request option.
|
|
11722
12128
|
* @throws {RequiredError}
|
|
11723
12129
|
*/
|
|
11724
|
-
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?:
|
|
12130
|
+
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<LivePhoto>;
|
|
11725
12131
|
};
|
|
11726
12132
|
/**
|
|
11727
12133
|
* DefaultApi - object-oriented interface
|
|
@@ -12304,7 +12710,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12304
12710
|
/**
|
|
12305
12711
|
* Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
|
|
12306
12712
|
* @summary Upload a document
|
|
12307
|
-
* @param {
|
|
12713
|
+
* @param {DocumentTypes} type The type of document
|
|
12308
12714
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
12309
12715
|
* @param {FileTransfer} file The file to be uploaded.
|
|
12310
12716
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
@@ -12316,7 +12722,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12316
12722
|
* @throws {RequiredError}
|
|
12317
12723
|
* @memberof DefaultApi
|
|
12318
12724
|
*/
|
|
12319
|
-
uploadDocument(type:
|
|
12725
|
+
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>>;
|
|
12320
12726
|
/**
|
|
12321
12727
|
* 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.
|
|
12322
12728
|
* @summary Upload ID photo
|