@onfido/api 5.4.0 → 5.5.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 +159 -71
- package/dist/api.js +2 -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 +159 -71
- package/dist/esm/api.js +2 -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/esm/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
|
*
|
|
@@ -6312,6 +6312,18 @@ export interface IdentityEnhancedBreakdown {
|
|
|
6312
6312
|
* @memberof IdentityEnhancedBreakdown
|
|
6313
6313
|
*/
|
|
6314
6314
|
'mortality'?: IdentityEnhancedBreakdownMortality;
|
|
6315
|
+
/**
|
|
6316
|
+
*
|
|
6317
|
+
* @type {IdrSsnBreakdown}
|
|
6318
|
+
* @memberof IdentityEnhancedBreakdown
|
|
6319
|
+
*/
|
|
6320
|
+
'ssn'?: IdrSsnBreakdown;
|
|
6321
|
+
/**
|
|
6322
|
+
*
|
|
6323
|
+
* @type {IdrSsnBreakdown}
|
|
6324
|
+
* @memberof IdentityEnhancedBreakdown
|
|
6325
|
+
*/
|
|
6326
|
+
'ssn1'?: IdrSsnBreakdown;
|
|
6315
6327
|
}
|
|
6316
6328
|
/**
|
|
6317
6329
|
* Asserts if the applicant\'s address matches any sources.
|
|
@@ -6685,6 +6697,82 @@ export interface IdentityEnhancedReport {
|
|
|
6685
6697
|
*/
|
|
6686
6698
|
'properties'?: IdentityEnhancedProperties;
|
|
6687
6699
|
}
|
|
6700
|
+
/**
|
|
6701
|
+
*
|
|
6702
|
+
* @export
|
|
6703
|
+
* @interface IdrSsnBreakdown
|
|
6704
|
+
*/
|
|
6705
|
+
export interface IdrSsnBreakdown {
|
|
6706
|
+
/**
|
|
6707
|
+
*
|
|
6708
|
+
* @type {string}
|
|
6709
|
+
* @memberof IdrSsnBreakdown
|
|
6710
|
+
*/
|
|
6711
|
+
'result'?: string;
|
|
6712
|
+
/**
|
|
6713
|
+
*
|
|
6714
|
+
* @type {IdrSsnBreakdownBreakdown}
|
|
6715
|
+
* @memberof IdrSsnBreakdown
|
|
6716
|
+
*/
|
|
6717
|
+
'breakdown'?: IdrSsnBreakdownBreakdown;
|
|
6718
|
+
}
|
|
6719
|
+
/**
|
|
6720
|
+
*
|
|
6721
|
+
* @export
|
|
6722
|
+
* @interface IdrSsnBreakdownBreakdown
|
|
6723
|
+
*/
|
|
6724
|
+
export interface IdrSsnBreakdownBreakdown {
|
|
6725
|
+
/**
|
|
6726
|
+
*
|
|
6727
|
+
* @type {IdrSsnBreakdownBreakdownLast4DigitsMatch}
|
|
6728
|
+
* @memberof IdrSsnBreakdownBreakdown
|
|
6729
|
+
*/
|
|
6730
|
+
'last_4_digits_match'?: IdrSsnBreakdownBreakdownLast4DigitsMatch;
|
|
6731
|
+
/**
|
|
6732
|
+
*
|
|
6733
|
+
* @type {IdrSsnBreakdownBreakdownFullMatch}
|
|
6734
|
+
* @memberof IdrSsnBreakdownBreakdown
|
|
6735
|
+
*/
|
|
6736
|
+
'full_match'?: IdrSsnBreakdownBreakdownFullMatch;
|
|
6737
|
+
}
|
|
6738
|
+
/**
|
|
6739
|
+
* Social security number fully matches
|
|
6740
|
+
* @export
|
|
6741
|
+
* @interface IdrSsnBreakdownBreakdownFullMatch
|
|
6742
|
+
*/
|
|
6743
|
+
export interface IdrSsnBreakdownBreakdownFullMatch {
|
|
6744
|
+
/**
|
|
6745
|
+
*
|
|
6746
|
+
* @type {string}
|
|
6747
|
+
* @memberof IdrSsnBreakdownBreakdownFullMatch
|
|
6748
|
+
*/
|
|
6749
|
+
'result'?: string;
|
|
6750
|
+
/**
|
|
6751
|
+
*
|
|
6752
|
+
* @type {object}
|
|
6753
|
+
* @memberof IdrSsnBreakdownBreakdownFullMatch
|
|
6754
|
+
*/
|
|
6755
|
+
'properties'?: object;
|
|
6756
|
+
}
|
|
6757
|
+
/**
|
|
6758
|
+
* Last 4 digits of social security number match
|
|
6759
|
+
* @export
|
|
6760
|
+
* @interface IdrSsnBreakdownBreakdownLast4DigitsMatch
|
|
6761
|
+
*/
|
|
6762
|
+
export interface IdrSsnBreakdownBreakdownLast4DigitsMatch {
|
|
6763
|
+
/**
|
|
6764
|
+
*
|
|
6765
|
+
* @type {string}
|
|
6766
|
+
* @memberof IdrSsnBreakdownBreakdownLast4DigitsMatch
|
|
6767
|
+
*/
|
|
6768
|
+
'result'?: string;
|
|
6769
|
+
/**
|
|
6770
|
+
*
|
|
6771
|
+
* @type {object}
|
|
6772
|
+
* @memberof IdrSsnBreakdownBreakdownLast4DigitsMatch
|
|
6773
|
+
*/
|
|
6774
|
+
'properties'?: object;
|
|
6775
|
+
}
|
|
6688
6776
|
/**
|
|
6689
6777
|
*
|
|
6690
6778
|
* @export
|
|
@@ -12626,7 +12714,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12626
12714
|
* @throws {RequiredError}
|
|
12627
12715
|
* @memberof DefaultApi
|
|
12628
12716
|
*/
|
|
12629
|
-
cancelReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12717
|
+
cancelReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12630
12718
|
/**
|
|
12631
12719
|
* Completes a Send / Receive Data Task.
|
|
12632
12720
|
* @summary Complete Task
|
|
@@ -12637,7 +12725,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12637
12725
|
* @throws {RequiredError}
|
|
12638
12726
|
* @memberof DefaultApi
|
|
12639
12727
|
*/
|
|
12640
|
-
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12728
|
+
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12641
12729
|
/**
|
|
12642
12730
|
* Creates a single applicant. Returns an applicant object.
|
|
12643
12731
|
* @summary Create Applicant
|
|
@@ -12646,7 +12734,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12646
12734
|
* @throws {RequiredError}
|
|
12647
12735
|
* @memberof DefaultApi
|
|
12648
12736
|
*/
|
|
12649
|
-
createApplicant(applicantBuilder: ApplicantBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any>>;
|
|
12737
|
+
createApplicant(applicantBuilder: ApplicantBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any, {}>>;
|
|
12650
12738
|
/**
|
|
12651
12739
|
* Initiates a check for an applicant, which can contain one or more reports. Returns a check object.
|
|
12652
12740
|
* @summary Create a check
|
|
@@ -12655,7 +12743,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12655
12743
|
* @throws {RequiredError}
|
|
12656
12744
|
* @memberof DefaultApi
|
|
12657
12745
|
*/
|
|
12658
|
-
createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any>>;
|
|
12746
|
+
createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any, {}>>;
|
|
12659
12747
|
/**
|
|
12660
12748
|
* Triggers the generation of the Timeline File for the designated Workflow Run.
|
|
12661
12749
|
* @summary Create Timeline File for Workflow Run
|
|
@@ -12664,7 +12752,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12664
12752
|
* @throws {RequiredError}
|
|
12665
12753
|
* @memberof DefaultApi
|
|
12666
12754
|
*/
|
|
12667
|
-
createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TimelineFileReference, any>>;
|
|
12755
|
+
createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TimelineFileReference, any, {}>>;
|
|
12668
12756
|
/**
|
|
12669
12757
|
* Creates a new monitor for the applicant
|
|
12670
12758
|
* @summary Create monitor
|
|
@@ -12673,7 +12761,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12673
12761
|
* @throws {RequiredError}
|
|
12674
12762
|
* @memberof DefaultApi
|
|
12675
12763
|
*/
|
|
12676
|
-
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any>>;
|
|
12764
|
+
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any, {}>>;
|
|
12677
12765
|
/**
|
|
12678
12766
|
* Registers a webhook. Returns a webhook object.
|
|
12679
12767
|
* @summary Register webhook
|
|
@@ -12682,7 +12770,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12682
12770
|
* @throws {RequiredError}
|
|
12683
12771
|
* @memberof DefaultApi
|
|
12684
12772
|
*/
|
|
12685
|
-
createWebhook(webhookBuilder: WebhookBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any>>;
|
|
12773
|
+
createWebhook(webhookBuilder: WebhookBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any, {}>>;
|
|
12686
12774
|
/**
|
|
12687
12775
|
* Creates and starts a Workflow Run. Returns a Workflow Run object.
|
|
12688
12776
|
* @summary Create a Workflow Run
|
|
@@ -12691,7 +12779,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12691
12779
|
* @throws {RequiredError}
|
|
12692
12780
|
* @memberof DefaultApi
|
|
12693
12781
|
*/
|
|
12694
|
-
createWorkflowRun(workflowRunBuilder: WorkflowRunBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun, any>>;
|
|
12782
|
+
createWorkflowRun(workflowRunBuilder: WorkflowRunBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun, any, {}>>;
|
|
12695
12783
|
/**
|
|
12696
12784
|
* Deletes a single applicant.
|
|
12697
12785
|
* @summary Delete Applicant
|
|
@@ -12700,7 +12788,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12700
12788
|
* @throws {RequiredError}
|
|
12701
12789
|
* @memberof DefaultApi
|
|
12702
12790
|
*/
|
|
12703
|
-
deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12791
|
+
deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12704
12792
|
/**
|
|
12705
12793
|
* Deactivates the given monitor
|
|
12706
12794
|
* @summary Delete monitor
|
|
@@ -12709,7 +12797,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12709
12797
|
* @throws {RequiredError}
|
|
12710
12798
|
* @memberof DefaultApi
|
|
12711
12799
|
*/
|
|
12712
|
-
deleteWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12800
|
+
deleteWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12713
12801
|
/**
|
|
12714
12802
|
* Deletes a webhook.
|
|
12715
12803
|
* @summary Delete a webhook
|
|
@@ -12718,7 +12806,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12718
12806
|
* @throws {RequiredError}
|
|
12719
12807
|
* @memberof DefaultApi
|
|
12720
12808
|
*/
|
|
12721
|
-
deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12809
|
+
deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
12722
12810
|
/**
|
|
12723
12811
|
* Retrieves the signed document or signing transaction receipt depending on the id provided.
|
|
12724
12812
|
* @summary Retrieves the signed document or signing transaction receipt
|
|
@@ -12728,7 +12816,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12728
12816
|
* @throws {RequiredError}
|
|
12729
12817
|
* @memberof DefaultApi
|
|
12730
12818
|
*/
|
|
12731
|
-
downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12819
|
+
downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12732
12820
|
/**
|
|
12733
12821
|
* Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
|
|
12734
12822
|
* @summary Download check
|
|
@@ -12737,7 +12825,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12737
12825
|
* @throws {RequiredError}
|
|
12738
12826
|
* @memberof DefaultApi
|
|
12739
12827
|
*/
|
|
12740
|
-
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12828
|
+
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12741
12829
|
/**
|
|
12742
12830
|
* Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
|
12743
12831
|
* @summary Download document
|
|
@@ -12746,7 +12834,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12746
12834
|
* @throws {RequiredError}
|
|
12747
12835
|
* @memberof DefaultApi
|
|
12748
12836
|
*/
|
|
12749
|
-
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12837
|
+
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12750
12838
|
/**
|
|
12751
12839
|
* Downloads a document video. If successful, the response will be the binary data representing the video.
|
|
12752
12840
|
* @summary Download document video
|
|
@@ -12755,7 +12843,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12755
12843
|
* @throws {RequiredError}
|
|
12756
12844
|
* @memberof DefaultApi
|
|
12757
12845
|
*/
|
|
12758
|
-
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12846
|
+
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12759
12847
|
/**
|
|
12760
12848
|
* Retrieves the evidence folder for the designated Workflow Run
|
|
12761
12849
|
* @summary Retrieve Workflow Run Evidence Folder
|
|
@@ -12764,7 +12852,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12764
12852
|
* @throws {RequiredError}
|
|
12765
12853
|
* @memberof DefaultApi
|
|
12766
12854
|
*/
|
|
12767
|
-
downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12855
|
+
downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12768
12856
|
/**
|
|
12769
12857
|
* ID photos are downloaded using this endpoint.
|
|
12770
12858
|
* @summary Download ID photo
|
|
@@ -12773,7 +12861,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12773
12861
|
* @throws {RequiredError}
|
|
12774
12862
|
* @memberof DefaultApi
|
|
12775
12863
|
*/
|
|
12776
|
-
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12864
|
+
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12777
12865
|
/**
|
|
12778
12866
|
* Live photos are downloaded using this endpoint.
|
|
12779
12867
|
* @summary Download live photo
|
|
@@ -12782,7 +12870,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12782
12870
|
* @throws {RequiredError}
|
|
12783
12871
|
* @memberof DefaultApi
|
|
12784
12872
|
*/
|
|
12785
|
-
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12873
|
+
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12786
12874
|
/**
|
|
12787
12875
|
* Live videos are downloaded using this endpoint.
|
|
12788
12876
|
* @summary Download live video
|
|
@@ -12791,7 +12879,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12791
12879
|
* @throws {RequiredError}
|
|
12792
12880
|
* @memberof DefaultApi
|
|
12793
12881
|
*/
|
|
12794
|
-
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12882
|
+
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12795
12883
|
/**
|
|
12796
12884
|
* Returns the binary data representing a single frame from a live video.
|
|
12797
12885
|
* @summary Download live video frame
|
|
@@ -12800,7 +12888,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12800
12888
|
* @throws {RequiredError}
|
|
12801
12889
|
* @memberof DefaultApi
|
|
12802
12890
|
*/
|
|
12803
|
-
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12891
|
+
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12804
12892
|
/**
|
|
12805
12893
|
* Motion captures are downloaded using this endpoint.
|
|
12806
12894
|
* @summary Download motion capture
|
|
@@ -12809,7 +12897,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12809
12897
|
* @throws {RequiredError}
|
|
12810
12898
|
* @memberof DefaultApi
|
|
12811
12899
|
*/
|
|
12812
|
-
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12900
|
+
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12813
12901
|
/**
|
|
12814
12902
|
* Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
|
|
12815
12903
|
* @summary Download motion capture frame
|
|
@@ -12818,7 +12906,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12818
12906
|
* @throws {RequiredError}
|
|
12819
12907
|
* @memberof DefaultApi
|
|
12820
12908
|
*/
|
|
12821
|
-
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12909
|
+
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12822
12910
|
/**
|
|
12823
12911
|
* Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
|
12824
12912
|
* @summary Download NFC face
|
|
@@ -12827,7 +12915,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12827
12915
|
* @throws {RequiredError}
|
|
12828
12916
|
* @memberof DefaultApi
|
|
12829
12917
|
*/
|
|
12830
|
-
downloadNfcFace(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12918
|
+
downloadNfcFace(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12831
12919
|
/**
|
|
12832
12920
|
* Retrieves the signed document or application form depending on the file_id provided.
|
|
12833
12921
|
* @summary Retrieves the signed document or application form
|
|
@@ -12837,7 +12925,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12837
12925
|
* @throws {RequiredError}
|
|
12838
12926
|
* @memberof DefaultApi
|
|
12839
12927
|
*/
|
|
12840
|
-
downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12928
|
+
downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12841
12929
|
/**
|
|
12842
12930
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
12843
12931
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -12846,7 +12934,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12846
12934
|
* @throws {RequiredError}
|
|
12847
12935
|
* @memberof DefaultApi
|
|
12848
12936
|
*/
|
|
12849
|
-
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
12937
|
+
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12850
12938
|
/**
|
|
12851
12939
|
* Extract information from a document
|
|
12852
12940
|
* @summary Autofill
|
|
@@ -12855,7 +12943,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12855
12943
|
* @throws {RequiredError}
|
|
12856
12944
|
* @memberof DefaultApi
|
|
12857
12945
|
*/
|
|
12858
|
-
extract(extractRequest: ExtractRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Extraction, any>>;
|
|
12946
|
+
extract(extractRequest: ExtractRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Extraction, any, {}>>;
|
|
12859
12947
|
/**
|
|
12860
12948
|
* Search for addresses by postcode
|
|
12861
12949
|
* @summary Address Picker
|
|
@@ -12864,7 +12952,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12864
12952
|
* @throws {RequiredError}
|
|
12865
12953
|
* @memberof DefaultApi
|
|
12866
12954
|
*/
|
|
12867
|
-
findAddresses(postcode: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddressesList, any>>;
|
|
12955
|
+
findAddresses(postcode: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddressesList, any, {}>>;
|
|
12868
12956
|
/**
|
|
12869
12957
|
* Retrieves a single applicant. Returns an applicant object.
|
|
12870
12958
|
* @summary Retrieve Applicant
|
|
@@ -12873,7 +12961,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12873
12961
|
* @throws {RequiredError}
|
|
12874
12962
|
* @memberof DefaultApi
|
|
12875
12963
|
*/
|
|
12876
|
-
findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any>>;
|
|
12964
|
+
findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any, {}>>;
|
|
12877
12965
|
/**
|
|
12878
12966
|
* Retrieves consents for single applicant.
|
|
12879
12967
|
* @summary Retrieve Applicant Consents
|
|
@@ -12882,7 +12970,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12882
12970
|
* @throws {RequiredError}
|
|
12883
12971
|
* @memberof DefaultApi
|
|
12884
12972
|
*/
|
|
12885
|
-
findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantConsent[], any>>;
|
|
12973
|
+
findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantConsent[], any, {}>>;
|
|
12886
12974
|
/**
|
|
12887
12975
|
* Retrieves a single check. Returns a check object.
|
|
12888
12976
|
* @summary Retrieve a Check
|
|
@@ -12891,7 +12979,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12891
12979
|
* @throws {RequiredError}
|
|
12892
12980
|
* @memberof DefaultApi
|
|
12893
12981
|
*/
|
|
12894
|
-
findCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any>>;
|
|
12982
|
+
findCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any, {}>>;
|
|
12895
12983
|
/**
|
|
12896
12984
|
* A single document can be retrieved by calling this endpoint with the document\'s unique identifier.
|
|
12897
12985
|
* @summary Retrieve document
|
|
@@ -12900,7 +12988,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12900
12988
|
* @throws {RequiredError}
|
|
12901
12989
|
* @memberof DefaultApi
|
|
12902
12990
|
*/
|
|
12903
|
-
findDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any>>;
|
|
12991
|
+
findDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any, {}>>;
|
|
12904
12992
|
/**
|
|
12905
12993
|
* Retrieves a single ID photo. Returns a ID photo object.
|
|
12906
12994
|
* @summary Retrieve ID photo
|
|
@@ -12909,7 +12997,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12909
12997
|
* @throws {RequiredError}
|
|
12910
12998
|
* @memberof DefaultApi
|
|
12911
12999
|
*/
|
|
12912
|
-
findIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any>>;
|
|
13000
|
+
findIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any, {}>>;
|
|
12913
13001
|
/**
|
|
12914
13002
|
* Retrieves a single live photo. Returns a live photo object.
|
|
12915
13003
|
* @summary Retrieve live photo
|
|
@@ -12918,7 +13006,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12918
13006
|
* @throws {RequiredError}
|
|
12919
13007
|
* @memberof DefaultApi
|
|
12920
13008
|
*/
|
|
12921
|
-
findLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any>>;
|
|
13009
|
+
findLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any, {}>>;
|
|
12922
13010
|
/**
|
|
12923
13011
|
* Retrieves a single live video. Returns the corresponding live video object.
|
|
12924
13012
|
* @summary Retrieve live video
|
|
@@ -12927,7 +13015,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12927
13015
|
* @throws {RequiredError}
|
|
12928
13016
|
* @memberof DefaultApi
|
|
12929
13017
|
*/
|
|
12930
|
-
findLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideo, any>>;
|
|
13018
|
+
findLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideo, any, {}>>;
|
|
12931
13019
|
/**
|
|
12932
13020
|
* Retrieves a single motion capture. Returns the corresponding motion capture object.
|
|
12933
13021
|
* @summary Retrieve motion capture
|
|
@@ -12936,7 +13024,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12936
13024
|
* @throws {RequiredError}
|
|
12937
13025
|
* @memberof DefaultApi
|
|
12938
13026
|
*/
|
|
12939
|
-
findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapture, any>>;
|
|
13027
|
+
findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapture, any, {}>>;
|
|
12940
13028
|
/**
|
|
12941
13029
|
* A single report can be retrieved using this endpoint with the corresponding unique identifier.
|
|
12942
13030
|
* @summary Retrieve report
|
|
@@ -12945,7 +13033,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12945
13033
|
* @throws {RequiredError}
|
|
12946
13034
|
* @memberof DefaultApi
|
|
12947
13035
|
*/
|
|
12948
|
-
findReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Report, any>>;
|
|
13036
|
+
findReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Report, any, {}>>;
|
|
12949
13037
|
/**
|
|
12950
13038
|
* A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
|
|
12951
13039
|
* @summary Retrieve Task
|
|
@@ -12955,7 +13043,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12955
13043
|
* @throws {RequiredError}
|
|
12956
13044
|
* @memberof DefaultApi
|
|
12957
13045
|
*/
|
|
12958
|
-
findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Task, any>>;
|
|
13046
|
+
findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Task, any, {}>>;
|
|
12959
13047
|
/**
|
|
12960
13048
|
* Retrieves the Timeline File for the designated Workflow Run.
|
|
12961
13049
|
* @summary Retrieve Timeline File for Workflow Run
|
|
@@ -12965,7 +13053,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12965
13053
|
* @throws {RequiredError}
|
|
12966
13054
|
* @memberof DefaultApi
|
|
12967
13055
|
*/
|
|
12968
|
-
findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
13056
|
+
findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
|
|
12969
13057
|
/**
|
|
12970
13058
|
* Retrieves a single monitor
|
|
12971
13059
|
* @summary Retrieve monitor
|
|
@@ -12974,7 +13062,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12974
13062
|
* @throws {RequiredError}
|
|
12975
13063
|
* @memberof DefaultApi
|
|
12976
13064
|
*/
|
|
12977
|
-
findWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any>>;
|
|
13065
|
+
findWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any, {}>>;
|
|
12978
13066
|
/**
|
|
12979
13067
|
* Retrieves a single webhook. Returns a webhook object.
|
|
12980
13068
|
* @summary Retrieve a Webhook
|
|
@@ -12983,7 +13071,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12983
13071
|
* @throws {RequiredError}
|
|
12984
13072
|
* @memberof DefaultApi
|
|
12985
13073
|
*/
|
|
12986
|
-
findWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any>>;
|
|
13074
|
+
findWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any, {}>>;
|
|
12987
13075
|
/**
|
|
12988
13076
|
* A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
|
12989
13077
|
* @summary Retrieve Workflow Run
|
|
@@ -12992,7 +13080,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12992
13080
|
* @throws {RequiredError}
|
|
12993
13081
|
* @memberof DefaultApi
|
|
12994
13082
|
*/
|
|
12995
|
-
findWorkflowRun(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun, any>>;
|
|
13083
|
+
findWorkflowRun(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun, any, {}>>;
|
|
12996
13084
|
/**
|
|
12997
13085
|
* Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
|
|
12998
13086
|
* @summary Force new report creation (BETA)
|
|
@@ -13001,7 +13089,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13001
13089
|
* @throws {RequiredError}
|
|
13002
13090
|
* @memberof DefaultApi
|
|
13003
13091
|
*/
|
|
13004
|
-
forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
13092
|
+
forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
13005
13093
|
/**
|
|
13006
13094
|
* Generates an SDK token. Returns a token object containing the SDK token.
|
|
13007
13095
|
* @summary Generate a SDK token
|
|
@@ -13010,7 +13098,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13010
13098
|
* @throws {RequiredError}
|
|
13011
13099
|
* @memberof DefaultApi
|
|
13012
13100
|
*/
|
|
13013
|
-
generateSdkToken(sdkTokenBuilder: SdkTokenBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SdkToken, any>>;
|
|
13101
|
+
generateSdkToken(sdkTokenBuilder: SdkTokenBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SdkToken, any, {}>>;
|
|
13014
13102
|
/**
|
|
13015
13103
|
* Lists all applicants you\'ve created, sorted by creation date in descending order.
|
|
13016
13104
|
* @summary List Applicants
|
|
@@ -13021,7 +13109,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13021
13109
|
* @throws {RequiredError}
|
|
13022
13110
|
* @memberof DefaultApi
|
|
13023
13111
|
*/
|
|
13024
|
-
listApplicants(page?: number, perPage?: number, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantsList, any>>;
|
|
13112
|
+
listApplicants(page?: number, perPage?: number, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantsList, any, {}>>;
|
|
13025
13113
|
/**
|
|
13026
13114
|
* Retrieves a single check. Returns a check object.
|
|
13027
13115
|
* @summary Retrieve Checks
|
|
@@ -13030,7 +13118,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13030
13118
|
* @throws {RequiredError}
|
|
13031
13119
|
* @memberof DefaultApi
|
|
13032
13120
|
*/
|
|
13033
|
-
listChecks(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChecksList, any>>;
|
|
13121
|
+
listChecks(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChecksList, any, {}>>;
|
|
13034
13122
|
/**
|
|
13035
13123
|
* All documents belonging to an applicant can be listed from this endpoint
|
|
13036
13124
|
* @summary List documents
|
|
@@ -13039,7 +13127,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13039
13127
|
* @throws {RequiredError}
|
|
13040
13128
|
* @memberof DefaultApi
|
|
13041
13129
|
*/
|
|
13042
|
-
listDocuments(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentsList, any>>;
|
|
13130
|
+
listDocuments(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentsList, any, {}>>;
|
|
13043
13131
|
/**
|
|
13044
13132
|
* Lists the ID photos that belong to an applicant.
|
|
13045
13133
|
* @summary List ID photos
|
|
@@ -13048,7 +13136,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13048
13136
|
* @throws {RequiredError}
|
|
13049
13137
|
* @memberof DefaultApi
|
|
13050
13138
|
*/
|
|
13051
|
-
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhotosList, any>>;
|
|
13139
|
+
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhotosList, any, {}>>;
|
|
13052
13140
|
/**
|
|
13053
13141
|
* Lists the live photos that belong to an applicant.
|
|
13054
13142
|
* @summary List live photos
|
|
@@ -13057,7 +13145,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13057
13145
|
* @throws {RequiredError}
|
|
13058
13146
|
* @memberof DefaultApi
|
|
13059
13147
|
*/
|
|
13060
|
-
listLivePhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhotosList, any>>;
|
|
13148
|
+
listLivePhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhotosList, any, {}>>;
|
|
13061
13149
|
/**
|
|
13062
13150
|
* Lists all the live videos that belong to an applicant.
|
|
13063
13151
|
* @summary List live videos
|
|
@@ -13066,7 +13154,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13066
13154
|
* @throws {RequiredError}
|
|
13067
13155
|
* @memberof DefaultApi
|
|
13068
13156
|
*/
|
|
13069
|
-
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideosList, any>>;
|
|
13157
|
+
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideosList, any, {}>>;
|
|
13070
13158
|
/**
|
|
13071
13159
|
* Lists all the motion captures that belong to an applicant.
|
|
13072
13160
|
* @summary List motion captures
|
|
@@ -13075,7 +13163,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13075
13163
|
* @throws {RequiredError}
|
|
13076
13164
|
* @memberof DefaultApi
|
|
13077
13165
|
*/
|
|
13078
|
-
listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapturesList, any>>;
|
|
13166
|
+
listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapturesList, any, {}>>;
|
|
13079
13167
|
/**
|
|
13080
13168
|
* Returns all repeat attempts for a given Document report
|
|
13081
13169
|
* @summary Retrieve repeat attempts
|
|
@@ -13084,7 +13172,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13084
13172
|
* @throws {RequiredError}
|
|
13085
13173
|
* @memberof DefaultApi
|
|
13086
13174
|
*/
|
|
13087
|
-
listRepeatAttempts(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RepeatAttemptsList, any>>;
|
|
13175
|
+
listRepeatAttempts(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RepeatAttemptsList, any, {}>>;
|
|
13088
13176
|
/**
|
|
13089
13177
|
* All the reports belonging to a particular check can be listed from this endpoint.
|
|
13090
13178
|
* @summary List reports
|
|
@@ -13093,7 +13181,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13093
13181
|
* @throws {RequiredError}
|
|
13094
13182
|
* @memberof DefaultApi
|
|
13095
13183
|
*/
|
|
13096
|
-
listReports(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportsList, any>>;
|
|
13184
|
+
listReports(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportsList, any, {}>>;
|
|
13097
13185
|
/**
|
|
13098
13186
|
* The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
|
13099
13187
|
* @summary List Tasks
|
|
@@ -13102,7 +13190,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13102
13190
|
* @throws {RequiredError}
|
|
13103
13191
|
* @memberof DefaultApi
|
|
13104
13192
|
*/
|
|
13105
|
-
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskItem[], any>>;
|
|
13193
|
+
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskItem[], any, {}>>;
|
|
13106
13194
|
/**
|
|
13107
13195
|
* List match IDs on this monitor, as well as their enabled/disabled status
|
|
13108
13196
|
* @summary List matches (BETA)
|
|
@@ -13111,7 +13199,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13111
13199
|
* @throws {RequiredError}
|
|
13112
13200
|
* @memberof DefaultApi
|
|
13113
13201
|
*/
|
|
13114
|
-
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any>>;
|
|
13202
|
+
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any, {}>>;
|
|
13115
13203
|
/**
|
|
13116
13204
|
* List all available monitors for an applicant
|
|
13117
13205
|
* @summary List monitors
|
|
@@ -13121,7 +13209,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13121
13209
|
* @throws {RequiredError}
|
|
13122
13210
|
* @memberof DefaultApi
|
|
13123
13211
|
*/
|
|
13124
|
-
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorsList, any>>;
|
|
13212
|
+
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorsList, any, {}>>;
|
|
13125
13213
|
/**
|
|
13126
13214
|
* Lists all webhooks you\'ve created.
|
|
13127
13215
|
* @summary List webhooks
|
|
@@ -13129,7 +13217,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13129
13217
|
* @throws {RequiredError}
|
|
13130
13218
|
* @memberof DefaultApi
|
|
13131
13219
|
*/
|
|
13132
|
-
listWebhooks(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhooksList, any>>;
|
|
13220
|
+
listWebhooks(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhooksList, any, {}>>;
|
|
13133
13221
|
/**
|
|
13134
13222
|
* Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.
|
|
13135
13223
|
* @summary List Workflow Runs
|
|
@@ -13143,7 +13231,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13143
13231
|
* @throws {RequiredError}
|
|
13144
13232
|
* @memberof DefaultApi
|
|
13145
13233
|
*/
|
|
13146
|
-
listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun[], any>>;
|
|
13234
|
+
listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun[], any, {}>>;
|
|
13147
13235
|
/**
|
|
13148
13236
|
* Run a health check on the Onfido API
|
|
13149
13237
|
* @summary Ping
|
|
@@ -13151,7 +13239,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13151
13239
|
* @throws {RequiredError}
|
|
13152
13240
|
* @memberof DefaultApi
|
|
13153
13241
|
*/
|
|
13154
|
-
ping(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
13242
|
+
ping(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
13155
13243
|
/**
|
|
13156
13244
|
* Create Feedback on checks and reports
|
|
13157
13245
|
* @summary Fraud reporting (ALPHA)
|
|
@@ -13160,7 +13248,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13160
13248
|
* @throws {RequiredError}
|
|
13161
13249
|
* @memberof DefaultApi
|
|
13162
13250
|
*/
|
|
13163
|
-
postResultsFeedback(resultsFeedback: ResultsFeedback, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResultsFeedback, any>>;
|
|
13251
|
+
postResultsFeedback(resultsFeedback: ResultsFeedback, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResultsFeedback, any, {}>>;
|
|
13164
13252
|
/**
|
|
13165
13253
|
* Resends events to all webhooks registered with a matching environment in your account.
|
|
13166
13254
|
* @summary Resends webhooks
|
|
@@ -13169,7 +13257,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13169
13257
|
* @throws {RequiredError}
|
|
13170
13258
|
* @memberof DefaultApi
|
|
13171
13259
|
*/
|
|
13172
|
-
resendWebhooks(webhookResend: WebhookResend, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
13260
|
+
resendWebhooks(webhookResend: WebhookResend, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
13173
13261
|
/**
|
|
13174
13262
|
* Restores a single applicant scheduled for deletion.
|
|
13175
13263
|
* @summary Restore Applicant
|
|
@@ -13178,7 +13266,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13178
13266
|
* @throws {RequiredError}
|
|
13179
13267
|
* @memberof DefaultApi
|
|
13180
13268
|
*/
|
|
13181
|
-
restoreApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
13269
|
+
restoreApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
13182
13270
|
/**
|
|
13183
13271
|
* Resumes a paused check.
|
|
13184
13272
|
* @summary Resume a Check
|
|
@@ -13187,7 +13275,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13187
13275
|
* @throws {RequiredError}
|
|
13188
13276
|
* @memberof DefaultApi
|
|
13189
13277
|
*/
|
|
13190
|
-
resumeCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
13278
|
+
resumeCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
13191
13279
|
/**
|
|
13192
13280
|
* Resumes a single paused report.
|
|
13193
13281
|
* @summary Resume report
|
|
@@ -13196,7 +13284,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13196
13284
|
* @throws {RequiredError}
|
|
13197
13285
|
* @memberof DefaultApi
|
|
13198
13286
|
*/
|
|
13199
|
-
resumeReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
13287
|
+
resumeReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
13200
13288
|
/**
|
|
13201
13289
|
* 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
13290
|
* @summary Update Applicant
|
|
@@ -13206,7 +13294,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13206
13294
|
* @throws {RequiredError}
|
|
13207
13295
|
* @memberof DefaultApi
|
|
13208
13296
|
*/
|
|
13209
|
-
updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any>>;
|
|
13297
|
+
updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any, {}>>;
|
|
13210
13298
|
/**
|
|
13211
13299
|
* Update the status of the given matches
|
|
13212
13300
|
* @summary Set match status (BETA)
|
|
@@ -13216,7 +13304,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13216
13304
|
* @throws {RequiredError}
|
|
13217
13305
|
* @memberof DefaultApi
|
|
13218
13306
|
*/
|
|
13219
|
-
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any>>;
|
|
13307
|
+
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any, {}>>;
|
|
13220
13308
|
/**
|
|
13221
13309
|
* Edits a webhook. Returns the updated webhook object.
|
|
13222
13310
|
* @summary Edit a webhook
|
|
@@ -13226,7 +13314,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13226
13314
|
* @throws {RequiredError}
|
|
13227
13315
|
* @memberof DefaultApi
|
|
13228
13316
|
*/
|
|
13229
|
-
updateWebhook(webhookId: string, webhookUpdater: WebhookUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any>>;
|
|
13317
|
+
updateWebhook(webhookId: string, webhookUpdater: WebhookUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any, {}>>;
|
|
13230
13318
|
/**
|
|
13231
13319
|
* 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
13320
|
* @summary Upload a document
|
|
@@ -13242,7 +13330,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13242
13330
|
* @throws {RequiredError}
|
|
13243
13331
|
* @memberof DefaultApi
|
|
13244
13332
|
*/
|
|
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>>;
|
|
13333
|
+
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
13334
|
/**
|
|
13247
13335
|
* 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
13336
|
* @summary Upload ID photo
|
|
@@ -13252,7 +13340,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13252
13340
|
* @throws {RequiredError}
|
|
13253
13341
|
* @memberof DefaultApi
|
|
13254
13342
|
*/
|
|
13255
|
-
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any>>;
|
|
13343
|
+
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any, {}>>;
|
|
13256
13344
|
/**
|
|
13257
13345
|
* 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
13346
|
* @summary Upload live photo
|
|
@@ -13263,7 +13351,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13263
13351
|
* @throws {RequiredError}
|
|
13264
13352
|
* @memberof DefaultApi
|
|
13265
13353
|
*/
|
|
13266
|
-
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any>>;
|
|
13354
|
+
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any, {}>>;
|
|
13267
13355
|
}
|
|
13268
13356
|
/**
|
|
13269
13357
|
* @export
|