@onfido/api 5.4.0 → 5.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.d.ts +192 -71
- package/dist/api.js +29 -2
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +3 -3
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +3 -3
- package/dist/esm/api.d.ts +192 -71
- package/dist/esm/api.js +29 -2
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +3 -3
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +3 -3
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Onfido API v3.6
|
|
3
|
-
* The Onfido API (v3.6)
|
|
2
|
+
* Onfido Public API v3.6
|
|
3
|
+
* The Onfido Public API (v3.6)
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v3.6
|
|
6
6
|
*
|
|
@@ -4771,9 +4771,29 @@ export interface ExtractionDocumentClassification {
|
|
|
4771
4771
|
'version'?: string;
|
|
4772
4772
|
}
|
|
4773
4773
|
export declare const ExtractionDocumentClassificationSubtypeEnum: {
|
|
4774
|
+
readonly Spe: "SPE";
|
|
4775
|
+
readonly Ali: "ali";
|
|
4776
|
+
readonly Alien: "alien";
|
|
4777
|
+
readonly Com: "com";
|
|
4778
|
+
readonly Commercial: "commercial";
|
|
4779
|
+
readonly Dom: "dom";
|
|
4780
|
+
readonly Domestic: "domestic";
|
|
4774
4781
|
readonly Full: "full";
|
|
4775
4782
|
readonly NotFull: "not_full";
|
|
4783
|
+
readonly FullDrivingLicence: "full driving licence";
|
|
4784
|
+
readonly HeavyVehicle: "heavy_vehicle";
|
|
4785
|
+
readonly Learner: "learner";
|
|
4786
|
+
readonly MinorU21OrU18: "minor (u21 or u18)";
|
|
4787
|
+
readonly Mot: "mot";
|
|
4788
|
+
readonly Mul: "mul";
|
|
4776
4789
|
readonly Provisional: "provisional";
|
|
4790
|
+
readonly ProvisionalDrivingLicence: "provisional driving licence";
|
|
4791
|
+
readonly Ser: "ser";
|
|
4792
|
+
readonly Spe2: "spe";
|
|
4793
|
+
readonly Special: "special";
|
|
4794
|
+
readonly Standard: "standard";
|
|
4795
|
+
readonly Tem: "tem";
|
|
4796
|
+
readonly U21: "u21";
|
|
4777
4797
|
readonly UnknownDefaultOpenApi: "11184809";
|
|
4778
4798
|
};
|
|
4779
4799
|
export type ExtractionDocumentClassificationSubtypeEnum = typeof ExtractionDocumentClassificationSubtypeEnum[keyof typeof ExtractionDocumentClassificationSubtypeEnum];
|
|
@@ -6312,6 +6332,18 @@ export interface IdentityEnhancedBreakdown {
|
|
|
6312
6332
|
* @memberof IdentityEnhancedBreakdown
|
|
6313
6333
|
*/
|
|
6314
6334
|
'mortality'?: IdentityEnhancedBreakdownMortality;
|
|
6335
|
+
/**
|
|
6336
|
+
*
|
|
6337
|
+
* @type {IdrSsnBreakdown}
|
|
6338
|
+
* @memberof IdentityEnhancedBreakdown
|
|
6339
|
+
*/
|
|
6340
|
+
'ssn'?: IdrSsnBreakdown;
|
|
6341
|
+
/**
|
|
6342
|
+
*
|
|
6343
|
+
* @type {IdrSsnBreakdown}
|
|
6344
|
+
* @memberof IdentityEnhancedBreakdown
|
|
6345
|
+
*/
|
|
6346
|
+
'ssn1'?: IdrSsnBreakdown;
|
|
6315
6347
|
}
|
|
6316
6348
|
/**
|
|
6317
6349
|
* Asserts if the applicant\'s address matches any sources.
|
|
@@ -6685,6 +6717,82 @@ export interface IdentityEnhancedReport {
|
|
|
6685
6717
|
*/
|
|
6686
6718
|
'properties'?: IdentityEnhancedProperties;
|
|
6687
6719
|
}
|
|
6720
|
+
/**
|
|
6721
|
+
*
|
|
6722
|
+
* @export
|
|
6723
|
+
* @interface IdrSsnBreakdown
|
|
6724
|
+
*/
|
|
6725
|
+
export interface IdrSsnBreakdown {
|
|
6726
|
+
/**
|
|
6727
|
+
*
|
|
6728
|
+
* @type {string}
|
|
6729
|
+
* @memberof IdrSsnBreakdown
|
|
6730
|
+
*/
|
|
6731
|
+
'result'?: string;
|
|
6732
|
+
/**
|
|
6733
|
+
*
|
|
6734
|
+
* @type {IdrSsnBreakdownBreakdown}
|
|
6735
|
+
* @memberof IdrSsnBreakdown
|
|
6736
|
+
*/
|
|
6737
|
+
'breakdown'?: IdrSsnBreakdownBreakdown;
|
|
6738
|
+
}
|
|
6739
|
+
/**
|
|
6740
|
+
*
|
|
6741
|
+
* @export
|
|
6742
|
+
* @interface IdrSsnBreakdownBreakdown
|
|
6743
|
+
*/
|
|
6744
|
+
export interface IdrSsnBreakdownBreakdown {
|
|
6745
|
+
/**
|
|
6746
|
+
*
|
|
6747
|
+
* @type {IdrSsnBreakdownBreakdownLast4DigitsMatch}
|
|
6748
|
+
* @memberof IdrSsnBreakdownBreakdown
|
|
6749
|
+
*/
|
|
6750
|
+
'last_4_digits_match'?: IdrSsnBreakdownBreakdownLast4DigitsMatch;
|
|
6751
|
+
/**
|
|
6752
|
+
*
|
|
6753
|
+
* @type {IdrSsnBreakdownBreakdownFullMatch}
|
|
6754
|
+
* @memberof IdrSsnBreakdownBreakdown
|
|
6755
|
+
*/
|
|
6756
|
+
'full_match'?: IdrSsnBreakdownBreakdownFullMatch;
|
|
6757
|
+
}
|
|
6758
|
+
/**
|
|
6759
|
+
* Social security number fully matches
|
|
6760
|
+
* @export
|
|
6761
|
+
* @interface IdrSsnBreakdownBreakdownFullMatch
|
|
6762
|
+
*/
|
|
6763
|
+
export interface IdrSsnBreakdownBreakdownFullMatch {
|
|
6764
|
+
/**
|
|
6765
|
+
*
|
|
6766
|
+
* @type {string}
|
|
6767
|
+
* @memberof IdrSsnBreakdownBreakdownFullMatch
|
|
6768
|
+
*/
|
|
6769
|
+
'result'?: string;
|
|
6770
|
+
/**
|
|
6771
|
+
*
|
|
6772
|
+
* @type {object}
|
|
6773
|
+
* @memberof IdrSsnBreakdownBreakdownFullMatch
|
|
6774
|
+
*/
|
|
6775
|
+
'properties'?: object;
|
|
6776
|
+
}
|
|
6777
|
+
/**
|
|
6778
|
+
* Last 4 digits of social security number match
|
|
6779
|
+
* @export
|
|
6780
|
+
* @interface IdrSsnBreakdownBreakdownLast4DigitsMatch
|
|
6781
|
+
*/
|
|
6782
|
+
export interface IdrSsnBreakdownBreakdownLast4DigitsMatch {
|
|
6783
|
+
/**
|
|
6784
|
+
*
|
|
6785
|
+
* @type {string}
|
|
6786
|
+
* @memberof IdrSsnBreakdownBreakdownLast4DigitsMatch
|
|
6787
|
+
*/
|
|
6788
|
+
'result'?: string;
|
|
6789
|
+
/**
|
|
6790
|
+
*
|
|
6791
|
+
* @type {object}
|
|
6792
|
+
* @memberof IdrSsnBreakdownBreakdownLast4DigitsMatch
|
|
6793
|
+
*/
|
|
6794
|
+
'properties'?: object;
|
|
6795
|
+
}
|
|
6688
6796
|
/**
|
|
6689
6797
|
*
|
|
6690
6798
|
* @export
|
|
@@ -7591,6 +7699,13 @@ export declare const ProofOfAddressPropertiesDocumentTypeEnum: {
|
|
|
7591
7699
|
readonly PensionPropertyStatementLetter: "pension_property_statement_letter";
|
|
7592
7700
|
readonly IdentityDocumentWithAddress: "identity_document_with_address";
|
|
7593
7701
|
readonly ExchangeHouseStatement: "exchange_house_statement";
|
|
7702
|
+
readonly AccommodationTenancyCertificate: "accommodation_tenancy_certificate";
|
|
7703
|
+
readonly AddressCertificate: "address_certificate";
|
|
7704
|
+
readonly ElectricityBill: "electricity_bill";
|
|
7705
|
+
readonly GasBill: "gas_bill";
|
|
7706
|
+
readonly InternetBill: "internet_bill";
|
|
7707
|
+
readonly PhoneBill: "phone_bill";
|
|
7708
|
+
readonly WaterBill: "water_bill";
|
|
7594
7709
|
readonly UnknownDefaultOpenApi: "11184809";
|
|
7595
7710
|
};
|
|
7596
7711
|
export type ProofOfAddressPropertiesDocumentTypeEnum = typeof ProofOfAddressPropertiesDocumentTypeEnum[keyof typeof ProofOfAddressPropertiesDocumentTypeEnum];
|
|
@@ -10244,6 +10359,12 @@ export interface WebhookEventPayloadResource {
|
|
|
10244
10359
|
* @memberof WebhookEventPayloadResource
|
|
10245
10360
|
*/
|
|
10246
10361
|
'customer_user_id'?: string;
|
|
10362
|
+
/**
|
|
10363
|
+
* Pre-signed URL to download the timeline file for the Workflow Run.
|
|
10364
|
+
* @type {string}
|
|
10365
|
+
* @memberof WebhookEventPayloadResource
|
|
10366
|
+
*/
|
|
10367
|
+
'timeline_file_download_url'?: string;
|
|
10247
10368
|
}
|
|
10248
10369
|
/**
|
|
10249
10370
|
*
|
|
@@ -12626,7 +12747,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12626
12747
|
* @throws {RequiredError}
|
|
12627
12748
|
* @memberof DefaultApi
|
|
12628
12749
|
*/
|
|
12629
|
-
cancelReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12750
|
+
cancelReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12630
12751
|
/**
|
|
12631
12752
|
* Completes a Send / Receive Data Task.
|
|
12632
12753
|
* @summary Complete Task
|
|
@@ -12637,7 +12758,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12637
12758
|
* @throws {RequiredError}
|
|
12638
12759
|
* @memberof DefaultApi
|
|
12639
12760
|
*/
|
|
12640
|
-
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12761
|
+
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12641
12762
|
/**
|
|
12642
12763
|
* Creates a single applicant. Returns an applicant object.
|
|
12643
12764
|
* @summary Create Applicant
|
|
@@ -12646,7 +12767,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12646
12767
|
* @throws {RequiredError}
|
|
12647
12768
|
* @memberof DefaultApi
|
|
12648
12769
|
*/
|
|
12649
|
-
createApplicant(applicantBuilder: ApplicantBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any>>;
|
|
12770
|
+
createApplicant(applicantBuilder: ApplicantBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any, {}>>;
|
|
12650
12771
|
/**
|
|
12651
12772
|
* Initiates a check for an applicant, which can contain one or more reports. Returns a check object.
|
|
12652
12773
|
* @summary Create a check
|
|
@@ -12655,7 +12776,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12655
12776
|
* @throws {RequiredError}
|
|
12656
12777
|
* @memberof DefaultApi
|
|
12657
12778
|
*/
|
|
12658
|
-
createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any>>;
|
|
12779
|
+
createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any, {}>>;
|
|
12659
12780
|
/**
|
|
12660
12781
|
* Triggers the generation of the Timeline File for the designated Workflow Run.
|
|
12661
12782
|
* @summary Create Timeline File for Workflow Run
|
|
@@ -12664,7 +12785,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12664
12785
|
* @throws {RequiredError}
|
|
12665
12786
|
* @memberof DefaultApi
|
|
12666
12787
|
*/
|
|
12667
|
-
createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TimelineFileReference, any>>;
|
|
12788
|
+
createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TimelineFileReference, any, {}>>;
|
|
12668
12789
|
/**
|
|
12669
12790
|
* Creates a new monitor for the applicant
|
|
12670
12791
|
* @summary Create monitor
|
|
@@ -12673,7 +12794,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12673
12794
|
* @throws {RequiredError}
|
|
12674
12795
|
* @memberof DefaultApi
|
|
12675
12796
|
*/
|
|
12676
|
-
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any>>;
|
|
12797
|
+
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any, {}>>;
|
|
12677
12798
|
/**
|
|
12678
12799
|
* Registers a webhook. Returns a webhook object.
|
|
12679
12800
|
* @summary Register webhook
|
|
@@ -12682,7 +12803,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12682
12803
|
* @throws {RequiredError}
|
|
12683
12804
|
* @memberof DefaultApi
|
|
12684
12805
|
*/
|
|
12685
|
-
createWebhook(webhookBuilder: WebhookBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any>>;
|
|
12806
|
+
createWebhook(webhookBuilder: WebhookBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any, {}>>;
|
|
12686
12807
|
/**
|
|
12687
12808
|
* Creates and starts a Workflow Run. Returns a Workflow Run object.
|
|
12688
12809
|
* @summary Create a Workflow Run
|
|
@@ -12691,7 +12812,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12691
12812
|
* @throws {RequiredError}
|
|
12692
12813
|
* @memberof DefaultApi
|
|
12693
12814
|
*/
|
|
12694
|
-
createWorkflowRun(workflowRunBuilder: WorkflowRunBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun, any>>;
|
|
12815
|
+
createWorkflowRun(workflowRunBuilder: WorkflowRunBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun, any, {}>>;
|
|
12695
12816
|
/**
|
|
12696
12817
|
* Deletes a single applicant.
|
|
12697
12818
|
* @summary Delete Applicant
|
|
@@ -12700,7 +12821,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12700
12821
|
* @throws {RequiredError}
|
|
12701
12822
|
* @memberof DefaultApi
|
|
12702
12823
|
*/
|
|
12703
|
-
deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12824
|
+
deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12704
12825
|
/**
|
|
12705
12826
|
* Deactivates the given monitor
|
|
12706
12827
|
* @summary Delete monitor
|
|
@@ -12709,7 +12830,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12709
12830
|
* @throws {RequiredError}
|
|
12710
12831
|
* @memberof DefaultApi
|
|
12711
12832
|
*/
|
|
12712
|
-
deleteWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12833
|
+
deleteWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12713
12834
|
/**
|
|
12714
12835
|
* Deletes a webhook.
|
|
12715
12836
|
* @summary Delete a webhook
|
|
@@ -12718,7 +12839,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12718
12839
|
* @throws {RequiredError}
|
|
12719
12840
|
* @memberof DefaultApi
|
|
12720
12841
|
*/
|
|
12721
|
-
deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12842
|
+
deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12722
12843
|
/**
|
|
12723
12844
|
* Retrieves the signed document or signing transaction receipt depending on the id provided.
|
|
12724
12845
|
* @summary Retrieves the signed document or signing transaction receipt
|
|
@@ -12728,7 +12849,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12728
12849
|
* @throws {RequiredError}
|
|
12729
12850
|
* @memberof DefaultApi
|
|
12730
12851
|
*/
|
|
12731
|
-
downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12852
|
+
downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12732
12853
|
/**
|
|
12733
12854
|
* Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
|
|
12734
12855
|
* @summary Download check
|
|
@@ -12737,7 +12858,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12737
12858
|
* @throws {RequiredError}
|
|
12738
12859
|
* @memberof DefaultApi
|
|
12739
12860
|
*/
|
|
12740
|
-
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12861
|
+
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12741
12862
|
/**
|
|
12742
12863
|
* Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
|
12743
12864
|
* @summary Download document
|
|
@@ -12746,7 +12867,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12746
12867
|
* @throws {RequiredError}
|
|
12747
12868
|
* @memberof DefaultApi
|
|
12748
12869
|
*/
|
|
12749
|
-
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12870
|
+
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12750
12871
|
/**
|
|
12751
12872
|
* Downloads a document video. If successful, the response will be the binary data representing the video.
|
|
12752
12873
|
* @summary Download document video
|
|
@@ -12755,7 +12876,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12755
12876
|
* @throws {RequiredError}
|
|
12756
12877
|
* @memberof DefaultApi
|
|
12757
12878
|
*/
|
|
12758
|
-
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12879
|
+
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12759
12880
|
/**
|
|
12760
12881
|
* Retrieves the evidence folder for the designated Workflow Run
|
|
12761
12882
|
* @summary Retrieve Workflow Run Evidence Folder
|
|
@@ -12764,7 +12885,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12764
12885
|
* @throws {RequiredError}
|
|
12765
12886
|
* @memberof DefaultApi
|
|
12766
12887
|
*/
|
|
12767
|
-
downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12888
|
+
downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12768
12889
|
/**
|
|
12769
12890
|
* ID photos are downloaded using this endpoint.
|
|
12770
12891
|
* @summary Download ID photo
|
|
@@ -12773,7 +12894,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12773
12894
|
* @throws {RequiredError}
|
|
12774
12895
|
* @memberof DefaultApi
|
|
12775
12896
|
*/
|
|
12776
|
-
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12897
|
+
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12777
12898
|
/**
|
|
12778
12899
|
* Live photos are downloaded using this endpoint.
|
|
12779
12900
|
* @summary Download live photo
|
|
@@ -12782,7 +12903,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12782
12903
|
* @throws {RequiredError}
|
|
12783
12904
|
* @memberof DefaultApi
|
|
12784
12905
|
*/
|
|
12785
|
-
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12906
|
+
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12786
12907
|
/**
|
|
12787
12908
|
* Live videos are downloaded using this endpoint.
|
|
12788
12909
|
* @summary Download live video
|
|
@@ -12791,7 +12912,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12791
12912
|
* @throws {RequiredError}
|
|
12792
12913
|
* @memberof DefaultApi
|
|
12793
12914
|
*/
|
|
12794
|
-
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12915
|
+
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12795
12916
|
/**
|
|
12796
12917
|
* Returns the binary data representing a single frame from a live video.
|
|
12797
12918
|
* @summary Download live video frame
|
|
@@ -12800,7 +12921,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12800
12921
|
* @throws {RequiredError}
|
|
12801
12922
|
* @memberof DefaultApi
|
|
12802
12923
|
*/
|
|
12803
|
-
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12924
|
+
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12804
12925
|
/**
|
|
12805
12926
|
* Motion captures are downloaded using this endpoint.
|
|
12806
12927
|
* @summary Download motion capture
|
|
@@ -12809,7 +12930,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12809
12930
|
* @throws {RequiredError}
|
|
12810
12931
|
* @memberof DefaultApi
|
|
12811
12932
|
*/
|
|
12812
|
-
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12933
|
+
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12813
12934
|
/**
|
|
12814
12935
|
* Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
|
|
12815
12936
|
* @summary Download motion capture frame
|
|
@@ -12818,7 +12939,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12818
12939
|
* @throws {RequiredError}
|
|
12819
12940
|
* @memberof DefaultApi
|
|
12820
12941
|
*/
|
|
12821
|
-
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12942
|
+
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12822
12943
|
/**
|
|
12823
12944
|
* Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
|
12824
12945
|
* @summary Download NFC face
|
|
@@ -12827,7 +12948,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12827
12948
|
* @throws {RequiredError}
|
|
12828
12949
|
* @memberof DefaultApi
|
|
12829
12950
|
*/
|
|
12830
|
-
downloadNfcFace(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12951
|
+
downloadNfcFace(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12831
12952
|
/**
|
|
12832
12953
|
* Retrieves the signed document or application form depending on the file_id provided.
|
|
12833
12954
|
* @summary Retrieves the signed document or application form
|
|
@@ -12837,7 +12958,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12837
12958
|
* @throws {RequiredError}
|
|
12838
12959
|
* @memberof DefaultApi
|
|
12839
12960
|
*/
|
|
12840
|
-
downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12961
|
+
downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12841
12962
|
/**
|
|
12842
12963
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
12843
12964
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -12846,7 +12967,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12846
12967
|
* @throws {RequiredError}
|
|
12847
12968
|
* @memberof DefaultApi
|
|
12848
12969
|
*/
|
|
12849
|
-
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12970
|
+
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12850
12971
|
/**
|
|
12851
12972
|
* Extract information from a document
|
|
12852
12973
|
* @summary Autofill
|
|
@@ -12855,7 +12976,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12855
12976
|
* @throws {RequiredError}
|
|
12856
12977
|
* @memberof DefaultApi
|
|
12857
12978
|
*/
|
|
12858
|
-
extract(extractRequest: ExtractRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Extraction, any>>;
|
|
12979
|
+
extract(extractRequest: ExtractRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Extraction, any, {}>>;
|
|
12859
12980
|
/**
|
|
12860
12981
|
* Search for addresses by postcode
|
|
12861
12982
|
* @summary Address Picker
|
|
@@ -12864,7 +12985,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12864
12985
|
* @throws {RequiredError}
|
|
12865
12986
|
* @memberof DefaultApi
|
|
12866
12987
|
*/
|
|
12867
|
-
findAddresses(postcode: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddressesList, any>>;
|
|
12988
|
+
findAddresses(postcode: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddressesList, any, {}>>;
|
|
12868
12989
|
/**
|
|
12869
12990
|
* Retrieves a single applicant. Returns an applicant object.
|
|
12870
12991
|
* @summary Retrieve Applicant
|
|
@@ -12873,7 +12994,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12873
12994
|
* @throws {RequiredError}
|
|
12874
12995
|
* @memberof DefaultApi
|
|
12875
12996
|
*/
|
|
12876
|
-
findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any>>;
|
|
12997
|
+
findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any, {}>>;
|
|
12877
12998
|
/**
|
|
12878
12999
|
* Retrieves consents for single applicant.
|
|
12879
13000
|
* @summary Retrieve Applicant Consents
|
|
@@ -12882,7 +13003,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12882
13003
|
* @throws {RequiredError}
|
|
12883
13004
|
* @memberof DefaultApi
|
|
12884
13005
|
*/
|
|
12885
|
-
findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantConsent[], any>>;
|
|
13006
|
+
findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantConsent[], any, {}>>;
|
|
12886
13007
|
/**
|
|
12887
13008
|
* Retrieves a single check. Returns a check object.
|
|
12888
13009
|
* @summary Retrieve a Check
|
|
@@ -12891,7 +13012,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12891
13012
|
* @throws {RequiredError}
|
|
12892
13013
|
* @memberof DefaultApi
|
|
12893
13014
|
*/
|
|
12894
|
-
findCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any>>;
|
|
13015
|
+
findCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any, {}>>;
|
|
12895
13016
|
/**
|
|
12896
13017
|
* A single document can be retrieved by calling this endpoint with the document\'s unique identifier.
|
|
12897
13018
|
* @summary Retrieve document
|
|
@@ -12900,7 +13021,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12900
13021
|
* @throws {RequiredError}
|
|
12901
13022
|
* @memberof DefaultApi
|
|
12902
13023
|
*/
|
|
12903
|
-
findDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any>>;
|
|
13024
|
+
findDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any, {}>>;
|
|
12904
13025
|
/**
|
|
12905
13026
|
* Retrieves a single ID photo. Returns a ID photo object.
|
|
12906
13027
|
* @summary Retrieve ID photo
|
|
@@ -12909,7 +13030,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12909
13030
|
* @throws {RequiredError}
|
|
12910
13031
|
* @memberof DefaultApi
|
|
12911
13032
|
*/
|
|
12912
|
-
findIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any>>;
|
|
13033
|
+
findIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any, {}>>;
|
|
12913
13034
|
/**
|
|
12914
13035
|
* Retrieves a single live photo. Returns a live photo object.
|
|
12915
13036
|
* @summary Retrieve live photo
|
|
@@ -12918,7 +13039,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12918
13039
|
* @throws {RequiredError}
|
|
12919
13040
|
* @memberof DefaultApi
|
|
12920
13041
|
*/
|
|
12921
|
-
findLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any>>;
|
|
13042
|
+
findLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any, {}>>;
|
|
12922
13043
|
/**
|
|
12923
13044
|
* Retrieves a single live video. Returns the corresponding live video object.
|
|
12924
13045
|
* @summary Retrieve live video
|
|
@@ -12927,7 +13048,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12927
13048
|
* @throws {RequiredError}
|
|
12928
13049
|
* @memberof DefaultApi
|
|
12929
13050
|
*/
|
|
12930
|
-
findLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideo, any>>;
|
|
13051
|
+
findLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideo, any, {}>>;
|
|
12931
13052
|
/**
|
|
12932
13053
|
* Retrieves a single motion capture. Returns the corresponding motion capture object.
|
|
12933
13054
|
* @summary Retrieve motion capture
|
|
@@ -12936,7 +13057,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12936
13057
|
* @throws {RequiredError}
|
|
12937
13058
|
* @memberof DefaultApi
|
|
12938
13059
|
*/
|
|
12939
|
-
findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapture, any>>;
|
|
13060
|
+
findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapture, any, {}>>;
|
|
12940
13061
|
/**
|
|
12941
13062
|
* A single report can be retrieved using this endpoint with the corresponding unique identifier.
|
|
12942
13063
|
* @summary Retrieve report
|
|
@@ -12945,7 +13066,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12945
13066
|
* @throws {RequiredError}
|
|
12946
13067
|
* @memberof DefaultApi
|
|
12947
13068
|
*/
|
|
12948
|
-
findReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Report, any>>;
|
|
13069
|
+
findReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Report, any, {}>>;
|
|
12949
13070
|
/**
|
|
12950
13071
|
* A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
|
|
12951
13072
|
* @summary Retrieve Task
|
|
@@ -12955,7 +13076,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12955
13076
|
* @throws {RequiredError}
|
|
12956
13077
|
* @memberof DefaultApi
|
|
12957
13078
|
*/
|
|
12958
|
-
findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Task, any>>;
|
|
13079
|
+
findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Task, any, {}>>;
|
|
12959
13080
|
/**
|
|
12960
13081
|
* Retrieves the Timeline File for the designated Workflow Run.
|
|
12961
13082
|
* @summary Retrieve Timeline File for Workflow Run
|
|
@@ -12965,7 +13086,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12965
13086
|
* @throws {RequiredError}
|
|
12966
13087
|
* @memberof DefaultApi
|
|
12967
13088
|
*/
|
|
12968
|
-
findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
13089
|
+
findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12969
13090
|
/**
|
|
12970
13091
|
* Retrieves a single monitor
|
|
12971
13092
|
* @summary Retrieve monitor
|
|
@@ -12974,7 +13095,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12974
13095
|
* @throws {RequiredError}
|
|
12975
13096
|
* @memberof DefaultApi
|
|
12976
13097
|
*/
|
|
12977
|
-
findWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any>>;
|
|
13098
|
+
findWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any, {}>>;
|
|
12978
13099
|
/**
|
|
12979
13100
|
* Retrieves a single webhook. Returns a webhook object.
|
|
12980
13101
|
* @summary Retrieve a Webhook
|
|
@@ -12983,7 +13104,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12983
13104
|
* @throws {RequiredError}
|
|
12984
13105
|
* @memberof DefaultApi
|
|
12985
13106
|
*/
|
|
12986
|
-
findWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any>>;
|
|
13107
|
+
findWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any, {}>>;
|
|
12987
13108
|
/**
|
|
12988
13109
|
* A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
|
12989
13110
|
* @summary Retrieve Workflow Run
|
|
@@ -12992,7 +13113,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12992
13113
|
* @throws {RequiredError}
|
|
12993
13114
|
* @memberof DefaultApi
|
|
12994
13115
|
*/
|
|
12995
|
-
findWorkflowRun(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun, any>>;
|
|
13116
|
+
findWorkflowRun(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun, any, {}>>;
|
|
12996
13117
|
/**
|
|
12997
13118
|
* Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
|
|
12998
13119
|
* @summary Force new report creation (BETA)
|
|
@@ -13001,7 +13122,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13001
13122
|
* @throws {RequiredError}
|
|
13002
13123
|
* @memberof DefaultApi
|
|
13003
13124
|
*/
|
|
13004
|
-
forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
13125
|
+
forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
13005
13126
|
/**
|
|
13006
13127
|
* Generates an SDK token. Returns a token object containing the SDK token.
|
|
13007
13128
|
* @summary Generate a SDK token
|
|
@@ -13010,7 +13131,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13010
13131
|
* @throws {RequiredError}
|
|
13011
13132
|
* @memberof DefaultApi
|
|
13012
13133
|
*/
|
|
13013
|
-
generateSdkToken(sdkTokenBuilder: SdkTokenBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SdkToken, any>>;
|
|
13134
|
+
generateSdkToken(sdkTokenBuilder: SdkTokenBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SdkToken, any, {}>>;
|
|
13014
13135
|
/**
|
|
13015
13136
|
* Lists all applicants you\'ve created, sorted by creation date in descending order.
|
|
13016
13137
|
* @summary List Applicants
|
|
@@ -13021,7 +13142,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13021
13142
|
* @throws {RequiredError}
|
|
13022
13143
|
* @memberof DefaultApi
|
|
13023
13144
|
*/
|
|
13024
|
-
listApplicants(page?: number, perPage?: number, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantsList, any>>;
|
|
13145
|
+
listApplicants(page?: number, perPage?: number, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantsList, any, {}>>;
|
|
13025
13146
|
/**
|
|
13026
13147
|
* Retrieves a single check. Returns a check object.
|
|
13027
13148
|
* @summary Retrieve Checks
|
|
@@ -13030,7 +13151,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13030
13151
|
* @throws {RequiredError}
|
|
13031
13152
|
* @memberof DefaultApi
|
|
13032
13153
|
*/
|
|
13033
|
-
listChecks(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChecksList, any>>;
|
|
13154
|
+
listChecks(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChecksList, any, {}>>;
|
|
13034
13155
|
/**
|
|
13035
13156
|
* All documents belonging to an applicant can be listed from this endpoint
|
|
13036
13157
|
* @summary List documents
|
|
@@ -13039,7 +13160,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13039
13160
|
* @throws {RequiredError}
|
|
13040
13161
|
* @memberof DefaultApi
|
|
13041
13162
|
*/
|
|
13042
|
-
listDocuments(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentsList, any>>;
|
|
13163
|
+
listDocuments(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentsList, any, {}>>;
|
|
13043
13164
|
/**
|
|
13044
13165
|
* Lists the ID photos that belong to an applicant.
|
|
13045
13166
|
* @summary List ID photos
|
|
@@ -13048,7 +13169,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13048
13169
|
* @throws {RequiredError}
|
|
13049
13170
|
* @memberof DefaultApi
|
|
13050
13171
|
*/
|
|
13051
|
-
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhotosList, any>>;
|
|
13172
|
+
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhotosList, any, {}>>;
|
|
13052
13173
|
/**
|
|
13053
13174
|
* Lists the live photos that belong to an applicant.
|
|
13054
13175
|
* @summary List live photos
|
|
@@ -13057,7 +13178,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13057
13178
|
* @throws {RequiredError}
|
|
13058
13179
|
* @memberof DefaultApi
|
|
13059
13180
|
*/
|
|
13060
|
-
listLivePhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhotosList, any>>;
|
|
13181
|
+
listLivePhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhotosList, any, {}>>;
|
|
13061
13182
|
/**
|
|
13062
13183
|
* Lists all the live videos that belong to an applicant.
|
|
13063
13184
|
* @summary List live videos
|
|
@@ -13066,7 +13187,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13066
13187
|
* @throws {RequiredError}
|
|
13067
13188
|
* @memberof DefaultApi
|
|
13068
13189
|
*/
|
|
13069
|
-
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideosList, any>>;
|
|
13190
|
+
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideosList, any, {}>>;
|
|
13070
13191
|
/**
|
|
13071
13192
|
* Lists all the motion captures that belong to an applicant.
|
|
13072
13193
|
* @summary List motion captures
|
|
@@ -13075,7 +13196,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13075
13196
|
* @throws {RequiredError}
|
|
13076
13197
|
* @memberof DefaultApi
|
|
13077
13198
|
*/
|
|
13078
|
-
listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapturesList, any>>;
|
|
13199
|
+
listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapturesList, any, {}>>;
|
|
13079
13200
|
/**
|
|
13080
13201
|
* Returns all repeat attempts for a given Document report
|
|
13081
13202
|
* @summary Retrieve repeat attempts
|
|
@@ -13084,7 +13205,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13084
13205
|
* @throws {RequiredError}
|
|
13085
13206
|
* @memberof DefaultApi
|
|
13086
13207
|
*/
|
|
13087
|
-
listRepeatAttempts(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RepeatAttemptsList, any>>;
|
|
13208
|
+
listRepeatAttempts(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RepeatAttemptsList, any, {}>>;
|
|
13088
13209
|
/**
|
|
13089
13210
|
* All the reports belonging to a particular check can be listed from this endpoint.
|
|
13090
13211
|
* @summary List reports
|
|
@@ -13093,7 +13214,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13093
13214
|
* @throws {RequiredError}
|
|
13094
13215
|
* @memberof DefaultApi
|
|
13095
13216
|
*/
|
|
13096
|
-
listReports(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportsList, any>>;
|
|
13217
|
+
listReports(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportsList, any, {}>>;
|
|
13097
13218
|
/**
|
|
13098
13219
|
* The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
|
13099
13220
|
* @summary List Tasks
|
|
@@ -13102,7 +13223,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13102
13223
|
* @throws {RequiredError}
|
|
13103
13224
|
* @memberof DefaultApi
|
|
13104
13225
|
*/
|
|
13105
|
-
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskItem[], any>>;
|
|
13226
|
+
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskItem[], any, {}>>;
|
|
13106
13227
|
/**
|
|
13107
13228
|
* List match IDs on this monitor, as well as their enabled/disabled status
|
|
13108
13229
|
* @summary List matches (BETA)
|
|
@@ -13111,7 +13232,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13111
13232
|
* @throws {RequiredError}
|
|
13112
13233
|
* @memberof DefaultApi
|
|
13113
13234
|
*/
|
|
13114
|
-
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any>>;
|
|
13235
|
+
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any, {}>>;
|
|
13115
13236
|
/**
|
|
13116
13237
|
* List all available monitors for an applicant
|
|
13117
13238
|
* @summary List monitors
|
|
@@ -13121,7 +13242,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13121
13242
|
* @throws {RequiredError}
|
|
13122
13243
|
* @memberof DefaultApi
|
|
13123
13244
|
*/
|
|
13124
|
-
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorsList, any>>;
|
|
13245
|
+
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorsList, any, {}>>;
|
|
13125
13246
|
/**
|
|
13126
13247
|
* Lists all webhooks you\'ve created.
|
|
13127
13248
|
* @summary List webhooks
|
|
@@ -13129,7 +13250,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13129
13250
|
* @throws {RequiredError}
|
|
13130
13251
|
* @memberof DefaultApi
|
|
13131
13252
|
*/
|
|
13132
|
-
listWebhooks(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhooksList, any>>;
|
|
13253
|
+
listWebhooks(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhooksList, any, {}>>;
|
|
13133
13254
|
/**
|
|
13134
13255
|
* Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.
|
|
13135
13256
|
* @summary List Workflow Runs
|
|
@@ -13143,7 +13264,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13143
13264
|
* @throws {RequiredError}
|
|
13144
13265
|
* @memberof DefaultApi
|
|
13145
13266
|
*/
|
|
13146
|
-
listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun[], any>>;
|
|
13267
|
+
listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun[], any, {}>>;
|
|
13147
13268
|
/**
|
|
13148
13269
|
* Run a health check on the Onfido API
|
|
13149
13270
|
* @summary Ping
|
|
@@ -13151,7 +13272,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13151
13272
|
* @throws {RequiredError}
|
|
13152
13273
|
* @memberof DefaultApi
|
|
13153
13274
|
*/
|
|
13154
|
-
ping(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
13275
|
+
ping(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
13155
13276
|
/**
|
|
13156
13277
|
* Create Feedback on checks and reports
|
|
13157
13278
|
* @summary Fraud reporting (ALPHA)
|
|
@@ -13160,7 +13281,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13160
13281
|
* @throws {RequiredError}
|
|
13161
13282
|
* @memberof DefaultApi
|
|
13162
13283
|
*/
|
|
13163
|
-
postResultsFeedback(resultsFeedback: ResultsFeedback, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResultsFeedback, any>>;
|
|
13284
|
+
postResultsFeedback(resultsFeedback: ResultsFeedback, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResultsFeedback, any, {}>>;
|
|
13164
13285
|
/**
|
|
13165
13286
|
* Resends events to all webhooks registered with a matching environment in your account.
|
|
13166
13287
|
* @summary Resends webhooks
|
|
@@ -13169,7 +13290,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13169
13290
|
* @throws {RequiredError}
|
|
13170
13291
|
* @memberof DefaultApi
|
|
13171
13292
|
*/
|
|
13172
|
-
resendWebhooks(webhookResend: WebhookResend, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
13293
|
+
resendWebhooks(webhookResend: WebhookResend, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
13173
13294
|
/**
|
|
13174
13295
|
* Restores a single applicant scheduled for deletion.
|
|
13175
13296
|
* @summary Restore Applicant
|
|
@@ -13178,7 +13299,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13178
13299
|
* @throws {RequiredError}
|
|
13179
13300
|
* @memberof DefaultApi
|
|
13180
13301
|
*/
|
|
13181
|
-
restoreApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
13302
|
+
restoreApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
13182
13303
|
/**
|
|
13183
13304
|
* Resumes a paused check.
|
|
13184
13305
|
* @summary Resume a Check
|
|
@@ -13187,7 +13308,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13187
13308
|
* @throws {RequiredError}
|
|
13188
13309
|
* @memberof DefaultApi
|
|
13189
13310
|
*/
|
|
13190
|
-
resumeCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
13311
|
+
resumeCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
13191
13312
|
/**
|
|
13192
13313
|
* Resumes a single paused report.
|
|
13193
13314
|
* @summary Resume report
|
|
@@ -13196,7 +13317,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13196
13317
|
* @throws {RequiredError}
|
|
13197
13318
|
* @memberof DefaultApi
|
|
13198
13319
|
*/
|
|
13199
|
-
resumeReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
13320
|
+
resumeReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
13200
13321
|
/**
|
|
13201
13322
|
* 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
|
|
13202
13323
|
* @summary Update Applicant
|
|
@@ -13206,7 +13327,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13206
13327
|
* @throws {RequiredError}
|
|
13207
13328
|
* @memberof DefaultApi
|
|
13208
13329
|
*/
|
|
13209
|
-
updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any>>;
|
|
13330
|
+
updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any, {}>>;
|
|
13210
13331
|
/**
|
|
13211
13332
|
* Update the status of the given matches
|
|
13212
13333
|
* @summary Set match status (BETA)
|
|
@@ -13216,7 +13337,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13216
13337
|
* @throws {RequiredError}
|
|
13217
13338
|
* @memberof DefaultApi
|
|
13218
13339
|
*/
|
|
13219
|
-
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any>>;
|
|
13340
|
+
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any, {}>>;
|
|
13220
13341
|
/**
|
|
13221
13342
|
* Edits a webhook. Returns the updated webhook object.
|
|
13222
13343
|
* @summary Edit a webhook
|
|
@@ -13226,7 +13347,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13226
13347
|
* @throws {RequiredError}
|
|
13227
13348
|
* @memberof DefaultApi
|
|
13228
13349
|
*/
|
|
13229
|
-
updateWebhook(webhookId: string, webhookUpdater: WebhookUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any>>;
|
|
13350
|
+
updateWebhook(webhookId: string, webhookUpdater: WebhookUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any, {}>>;
|
|
13230
13351
|
/**
|
|
13231
13352
|
* 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.
|
|
13232
13353
|
* @summary Upload a document
|
|
@@ -13242,7 +13363,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13242
13363
|
* @throws {RequiredError}
|
|
13243
13364
|
* @memberof DefaultApi
|
|
13244
13365
|
*/
|
|
13245
|
-
uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any>>;
|
|
13366
|
+
uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any, {}>>;
|
|
13246
13367
|
/**
|
|
13247
13368
|
* 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.
|
|
13248
13369
|
* @summary Upload ID photo
|
|
@@ -13252,7 +13373,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13252
13373
|
* @throws {RequiredError}
|
|
13253
13374
|
* @memberof DefaultApi
|
|
13254
13375
|
*/
|
|
13255
|
-
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any>>;
|
|
13376
|
+
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any, {}>>;
|
|
13256
13377
|
/**
|
|
13257
13378
|
* 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.
|
|
13258
13379
|
* @summary Upload live photo
|
|
@@ -13263,7 +13384,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13263
13384
|
* @throws {RequiredError}
|
|
13264
13385
|
* @memberof DefaultApi
|
|
13265
13386
|
*/
|
|
13266
|
-
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any>>;
|
|
13387
|
+
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any, {}>>;
|
|
13267
13388
|
}
|
|
13268
13389
|
/**
|
|
13269
13390
|
* @export
|