-
Notifications
You must be signed in to change notification settings - Fork 18
/
api.ts
15865 lines (15150 loc) · 557 KB
/
api.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* tslint:disable */
/* eslint-disable */
/**
* Onfido API v3.6
* The Onfido API (v3.6)
*
* The version of the OpenAPI document: v3.6
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from './configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// URLSearchParams not necessarily used
// @ts-ignore
import { URL, URLSearchParams } from 'url';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
import type { RequestArgs } from './base';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
import { FileTransfer } from './file-transfer';
import { AxiosHeaders } from 'axios';
globalAxios.interceptors.response.use(async (response) => {
if (response.headers instanceof AxiosHeaders && response.headers['content-type']) {
if ( ! response.headers['content-type'].toString().includes('application/json') ) {
const contentDisposition = response.headers['content-disposition'];
var filename = "";
if (contentDisposition && contentDisposition != "") {
const matcher = contentDisposition.match(/filename=['\"]?([^'\"\s]+)['\"]?/);
if (matcher != null) {
filename = matcher[1].replace(/.*[/\\\\]/g, "");
}
}
response.data = new FileTransfer(response.data, filename);
}
}
return response;
});
/**
*
* @export
* @interface Address
*/
export interface Address {
/**
* The flat number of this address
* @type {string}
* @memberof Address
*/
'flat_number'?: string;
/**
* The building number of this address
* @type {string}
* @memberof Address
*/
'building_number'?: string;
/**
* The building name of this address
* @type {string}
* @memberof Address
*/
'building_name'?: string;
/**
* The street of the applicant\'s address
* @type {string}
* @memberof Address
*/
'street'?: string;
/**
* The sub-street of the applicant\'s address
* @type {string}
* @memberof Address
*/
'sub_street'?: string;
/**
* The town of the applicant\'s address
* @type {string}
* @memberof Address
*/
'town'?: string;
/**
* The postcode or ZIP of the applicant\'s address
* @type {string}
* @memberof Address
*/
'postcode': string;
/**
* The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom
* @type {CountryCodes}
* @memberof Address
*/
'country': CountryCodes;
/**
* The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.
* @type {string}
* @memberof Address
*/
'state'?: string;
/**
* Line 1 of the applicant\'s address
* @type {string}
* @memberof Address
*/
'line1'?: string | null;
/**
* Line 2 of the applicant\'s address
* @type {string}
* @memberof Address
*/
'line2'?: string | null;
/**
* Line 3 of the applicant\'s address
* @type {string}
* @memberof Address
*/
'line3'?: string | null;
}
/**
*
* @export
* @interface AddressBuilder
*/
export interface AddressBuilder {
/**
* The flat number of this address
* @type {string}
* @memberof AddressBuilder
*/
'flat_number'?: string;
/**
* The building number of this address
* @type {string}
* @memberof AddressBuilder
*/
'building_number'?: string;
/**
* The building name of this address
* @type {string}
* @memberof AddressBuilder
*/
'building_name'?: string;
/**
* The street of the applicant\'s address
* @type {string}
* @memberof AddressBuilder
*/
'street'?: string;
/**
* The sub-street of the applicant\'s address
* @type {string}
* @memberof AddressBuilder
*/
'sub_street'?: string;
/**
* The town of the applicant\'s address
* @type {string}
* @memberof AddressBuilder
*/
'town'?: string;
/**
* The postcode or ZIP of the applicant\'s address
* @type {string}
* @memberof AddressBuilder
*/
'postcode': string;
/**
* The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom
* @type {CountryCodes}
* @memberof AddressBuilder
*/
'country': CountryCodes;
/**
* The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.
* @type {string}
* @memberof AddressBuilder
*/
'state'?: string;
/**
* Line 1 of the applicant\'s address
* @type {string}
* @memberof AddressBuilder
*/
'line1'?: string | null;
/**
* Line 2 of the applicant\'s address
* @type {string}
* @memberof AddressBuilder
*/
'line2'?: string | null;
/**
* Line 3 of the applicant\'s address
* @type {string}
* @memberof AddressBuilder
*/
'line3'?: string | null;
}
/**
*
* @export
* @interface AddressShared
*/
export interface AddressShared {
/**
* The flat number of this address
* @type {string}
* @memberof AddressShared
*/
'flat_number'?: string;
/**
* The building number of this address
* @type {string}
* @memberof AddressShared
*/
'building_number'?: string;
/**
* The building name of this address
* @type {string}
* @memberof AddressShared
*/
'building_name'?: string;
/**
* The street of the applicant\'s address
* @type {string}
* @memberof AddressShared
*/
'street'?: string;
/**
* The sub-street of the applicant\'s address
* @type {string}
* @memberof AddressShared
*/
'sub_street'?: string;
/**
* The town of the applicant\'s address
* @type {string}
* @memberof AddressShared
*/
'town'?: string;
/**
* The postcode or ZIP of the applicant\'s address
* @type {string}
* @memberof AddressShared
*/
'postcode': string;
/**
* The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom
* @type {CountryCodes}
* @memberof AddressShared
*/
'country': CountryCodes;
/**
* The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.
* @type {string}
* @memberof AddressShared
*/
'state'?: string;
/**
* Line 1 of the applicant\'s address
* @type {string}
* @memberof AddressShared
*/
'line1'?: string | null;
/**
* Line 2 of the applicant\'s address
* @type {string}
* @memberof AddressShared
*/
'line2'?: string | null;
/**
* Line 3 of the applicant\'s address
* @type {string}
* @memberof AddressShared
*/
'line3'?: string | null;
}
/**
*
* @export
* @interface AddressesList
*/
export interface AddressesList {
/**
*
* @type {Array<Address>}
* @memberof AddressesList
*/
'addresses'?: Array<Address>;
}
/**
*
* @export
* @interface Applicant
*/
export interface Applicant {
/**
* The applicant\'s email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.
* @type {string}
* @memberof Applicant
*/
'email'?: string;
/**
* The applicant\'s date of birth
* @type {string}
* @memberof Applicant
*/
'dob'?: string;
/**
*
* @type {Array<IdNumber>}
* @memberof Applicant
*/
'id_numbers'?: Array<IdNumber>;
/**
* The applicant\'s phone number
* @type {string}
* @memberof Applicant
*/
'phone_number'?: string;
/**
* The applicant\'s first name
* @type {string}
* @memberof Applicant
*/
'first_name'?: string;
/**
* The applicant\'s surname
* @type {string}
* @memberof Applicant
*/
'last_name'?: string;
/**
* The unique identifier for the applicant.
* @type {string}
* @memberof Applicant
*/
'id': string;
/**
* The date and time when this applicant was created.
* @type {string}
* @memberof Applicant
*/
'created_at'?: string;
/**
* The date and time when this applicant is scheduled to be deleted.
* @type {string}
* @memberof Applicant
*/
'delete_at'?: string;
/**
* The uri of this resource.
* @type {string}
* @memberof Applicant
*/
'href'?: string;
/**
*
* @type {boolean}
* @memberof Applicant
*/
'sandbox'?: boolean;
/**
*
* @type {Address}
* @memberof Applicant
*/
'address'?: Address;
/**
*
* @type {Location}
* @memberof Applicant
*/
'location'?: Location;
}
/**
*
* @export
* @interface ApplicantBuilder
*/
export interface ApplicantBuilder {
/**
* The applicant\'s email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.
* @type {string}
* @memberof ApplicantBuilder
*/
'email'?: string;
/**
* The applicant\'s date of birth
* @type {string}
* @memberof ApplicantBuilder
*/
'dob'?: string;
/**
*
* @type {Array<IdNumber>}
* @memberof ApplicantBuilder
*/
'id_numbers'?: Array<IdNumber>;
/**
* The applicant\'s phone number
* @type {string}
* @memberof ApplicantBuilder
*/
'phone_number'?: string;
/**
* The applicant\'s consents
* @type {Array<ApplicantConsentBuilder>}
* @memberof ApplicantBuilder
*/
'consents'?: Array<ApplicantConsentBuilder>;
/**
*
* @type {AddressBuilder}
* @memberof ApplicantBuilder
*/
'address'?: AddressBuilder;
/**
*
* @type {LocationBuilder}
* @memberof ApplicantBuilder
*/
'location'?: LocationBuilder;
/**
* The applicant\'s first name
* @type {string}
* @memberof ApplicantBuilder
*/
'first_name': string;
/**
* The applicant\'s surname
* @type {string}
* @memberof ApplicantBuilder
*/
'last_name': string;
}
/**
*
* @export
* @interface ApplicantConsentBuilder
*/
export interface ApplicantConsentBuilder {
/**
*
* @type {ApplicantConsentName}
* @memberof ApplicantConsentBuilder
*/
'name': ApplicantConsentName;
/**
*
* @type {boolean}
* @memberof ApplicantConsentBuilder
*/
'granted': boolean;
}
/**
*
* @export
* @enum {string}
*/
export const ApplicantConsentName = {
PrivacyNoticesRead: 'privacy_notices_read',
SsnVerification: 'ssn_verification',
PhoneNumberVerification: 'phone_number_verification',
UnknownDefaultOpenApi: '11184809'
} as const;
export type ApplicantConsentName = typeof ApplicantConsentName[keyof typeof ApplicantConsentName];
/**
*
* @export
* @interface ApplicantCreate
*/
export interface ApplicantCreate {
/**
* The applicant\'s first name
* @type {string}
* @memberof ApplicantCreate
*/
'first_name': string;
/**
* The applicant\'s surname
* @type {string}
* @memberof ApplicantCreate
*/
'last_name': string;
}
/**
*
* @export
* @interface ApplicantRequest
*/
export interface ApplicantRequest {
/**
* The applicant\'s consents
* @type {Array<ApplicantConsentBuilder>}
* @memberof ApplicantRequest
*/
'consents'?: Array<ApplicantConsentBuilder>;
/**
*
* @type {AddressBuilder}
* @memberof ApplicantRequest
*/
'address'?: AddressBuilder;
/**
*
* @type {LocationBuilder}
* @memberof ApplicantRequest
*/
'location'?: LocationBuilder;
}
/**
*
* @export
* @interface ApplicantResponse
*/
export interface ApplicantResponse {
/**
* The applicant\'s first name
* @type {string}
* @memberof ApplicantResponse
*/
'first_name'?: string;
/**
* The applicant\'s surname
* @type {string}
* @memberof ApplicantResponse
*/
'last_name'?: string;
/**
* The unique identifier for the applicant.
* @type {string}
* @memberof ApplicantResponse
*/
'id': string;
/**
* The date and time when this applicant was created.
* @type {string}
* @memberof ApplicantResponse
*/
'created_at'?: string;
/**
* The date and time when this applicant is scheduled to be deleted.
* @type {string}
* @memberof ApplicantResponse
*/
'delete_at'?: string;
/**
* The uri of this resource.
* @type {string}
* @memberof ApplicantResponse
*/
'href'?: string;
/**
*
* @type {boolean}
* @memberof ApplicantResponse
*/
'sandbox'?: boolean;
/**
*
* @type {Address}
* @memberof ApplicantResponse
*/
'address'?: Address;
/**
*
* @type {Location}
* @memberof ApplicantResponse
*/
'location'?: Location;
}
/**
*
* @export
* @interface ApplicantShared
*/
export interface ApplicantShared {
/**
* The applicant\'s email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.
* @type {string}
* @memberof ApplicantShared
*/
'email'?: string;
/**
* The applicant\'s date of birth
* @type {string}
* @memberof ApplicantShared
*/
'dob'?: string;
/**
*
* @type {Array<IdNumber>}
* @memberof ApplicantShared
*/
'id_numbers'?: Array<IdNumber>;
/**
* The applicant\'s phone number
* @type {string}
* @memberof ApplicantShared
*/
'phone_number'?: string;
}
/**
*
* @export
* @interface ApplicantUpdate
*/
export interface ApplicantUpdate {
/**
* The applicant\'s first name
* @type {string}
* @memberof ApplicantUpdate
*/
'first_name'?: string;
/**
* The applicant\'s surname
* @type {string}
* @memberof ApplicantUpdate
*/
'last_name'?: string;
}
/**
*
* @export
* @interface ApplicantUpdater
*/
export interface ApplicantUpdater {
/**
* The applicant\'s email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.
* @type {string}
* @memberof ApplicantUpdater
*/
'email'?: string;
/**
* The applicant\'s date of birth
* @type {string}
* @memberof ApplicantUpdater
*/
'dob'?: string;
/**
*
* @type {Array<IdNumber>}
* @memberof ApplicantUpdater
*/
'id_numbers'?: Array<IdNumber>;
/**
* The applicant\'s phone number
* @type {string}
* @memberof ApplicantUpdater
*/
'phone_number'?: string;
/**
* The applicant\'s consents
* @type {Array<ApplicantConsentBuilder>}
* @memberof ApplicantUpdater
*/
'consents'?: Array<ApplicantConsentBuilder>;
/**
*
* @type {AddressBuilder}
* @memberof ApplicantUpdater
*/
'address'?: AddressBuilder;
/**
*
* @type {LocationBuilder}
* @memberof ApplicantUpdater
*/
'location'?: LocationBuilder;
/**
* The applicant\'s first name
* @type {string}
* @memberof ApplicantUpdater
*/
'first_name'?: string;
/**
* The applicant\'s surname
* @type {string}
* @memberof ApplicantUpdater
*/
'last_name'?: string;
}
/**
*
* @export
* @interface ApplicantsList
*/
export interface ApplicantsList {
/**
*
* @type {Array<Applicant>}
* @memberof ApplicantsList
*/
'applicants': Array<Applicant>;
}
/**
*
* @export
* @interface Check
*/
export interface Check {
/**
* An array of webhook ids describing which webhooks to trigger for this check.
* @type {Array<string>}
* @memberof Check
*/
'webhook_ids'?: Array<string>;
/**
* The ID of the applicant to do the check on.
* @type {string}
* @memberof Check
*/
'applicant_id': string;
/**
* Send an applicant form to applicant to complete to proceed with check. Defaults to false.
* @type {boolean}
* @memberof Check
*/
'applicant_provides_data'?: boolean;
/**
* Array of tags being assigned to this check.
* @type {Array<string>}
* @memberof Check
*/
'tags'?: Array<string>;
/**
* For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
* @type {string}
* @memberof Check
*/
'redirect_uri'?: string;
/**
*
* @type {boolean}
* @memberof Check
*/
'privacy_notices_read_consent_given'?: boolean;
/**
* The unique identifier for the check.
* @type {string}
* @memberof Check
*/
'id': string;
/**
* The date and time when this check was created.
* @type {string}
* @memberof Check
*/
'created_at'?: string;
/**
* The uri of this resource.
* @type {string}
* @memberof Check
*/
'href'?: string;
/**
*
* @type {CheckStatus}
* @memberof Check
*/
'status'?: CheckStatus;
/**
* The overall result of the check, based on the results of the constituent reports.
* @type {string}
* @memberof Check
*/
'result'?: CheckResultEnum;
/**
* A link to the applicant form, if `applicant_provides_data` is `true`.
* @type {string}
* @memberof Check
*/
'form_uri'?: string;
/**
* A link to the corresponding results page on the Onfido dashboard.
* @type {string}
* @memberof Check
*/
'results_uri'?: string;
/**
* An array of report ids.
* @type {Array<string>}
* @memberof Check
*/
'report_ids'?: Array<string>;
/**
* Indicates whether the object was created in the sandbox or not.
* @type {boolean}
* @memberof Check
*/
'sandbox'?: boolean;
/**
*
* @type {boolean}
* @memberof Check
*/
'paused'?: boolean;
/**
*
* @type {string}
* @memberof Check
*/
'version'?: string;
}
export const CheckResultEnum = {
Clear: 'clear',
Consider: 'consider',
UnknownDefaultOpenApi: '11184809'
} as const;
export type CheckResultEnum = typeof CheckResultEnum[keyof typeof CheckResultEnum];
/**
*
* @export
* @interface CheckBuilder
*/
export interface CheckBuilder {
/**
* An array of webhook ids describing which webhooks to trigger for this check.
* @type {Array<string>}
* @memberof CheckBuilder
*/
'webhook_ids'?: Array<string>;
/**
* The ID of the applicant to do the check on.
* @type {string}
* @memberof CheckBuilder
*/
'applicant_id': string;
/**
* Send an applicant form to applicant to complete to proceed with check. Defaults to false.
* @type {boolean}
* @memberof CheckBuilder
*/
'applicant_provides_data'?: boolean;
/**
* Array of tags being assigned to this check.
* @type {Array<string>}
* @memberof CheckBuilder
*/
'tags'?: Array<string>;
/**
* For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
* @type {string}
* @memberof CheckBuilder
*/
'redirect_uri'?: string;
/**
*
* @type {boolean}
* @memberof CheckBuilder
*/
'privacy_notices_read_consent_given'?: boolean;
/**
* An array of report names (strings).
* @type {Array<ReportName>}
* @memberof CheckBuilder
*/
'report_names': Array<ReportName>;
/**
* Optional. An array of document ids, for use with Document reports only. If omitted, the Document report will use the most recently uploaded document by default.
* @type {Array<string>}
* @memberof CheckBuilder
*/
'document_ids'?: Array<string>;
/**
* Defaults to `true`. If set to `false`, you will only receive a response when all reports in your check have completed.
* @type {boolean}
* @memberof CheckBuilder
*/
'asynchronous'?: boolean;
/**
* For checks where `applicant_provides_data` is `true`, applicant form will not be automatically sent if `suppress_form_emails` is set to `true`. You can manually send the form at any time after the check has been created, using the link found in the form_uri attribute of the check object. Write-only. Defaults to false.
* @type {boolean}
* @memberof CheckBuilder
*/
'suppress_form_emails'?: boolean;
/**
* Triggers responses for particular sub-results for sandbox Document reports.
* @type {string}
* @memberof CheckBuilder
*/
'sub_result'?: string;
/**
* Array of names of particular reports to return consider as their results. This is a feature available in sandbox testing
* @type {Array<ReportName>}
* @memberof CheckBuilder
*/
'consider'?: Array<ReportName>;
/**
*
* @type {UsDrivingLicenceBuilder}
* @memberof CheckBuilder
*/
'us_driving_licence'?: UsDrivingLicenceBuilder;
}
/**
*
* @export
* @interface CheckRequest
*/
export interface CheckRequest {
/**
* An array of report names (strings).
* @type {Array<ReportName>}
* @memberof CheckRequest
*/
'report_names': Array<ReportName>;
/**
* Optional. An array of document ids, for use with Document reports only. If omitted, the Document report will use the most recently uploaded document by default.
* @type {Array<string>}
* @memberof CheckRequest
*/
'document_ids'?: Array<string>;
/**
* Send an applicant form to applicant to complete to proceed with check. Defaults to false.
* @type {boolean}
* @memberof CheckRequest
*/
'applicant_provides_data'?: boolean;
/**
* Defaults to `true`. If set to `false`, you will only receive a response when all reports in your check have completed.
* @type {boolean}
* @memberof CheckRequest
*/
'asynchronous'?: boolean;
/**
* For checks where `applicant_provides_data` is `true`, applicant form will not be automatically sent if `suppress_form_emails` is set to `true`. You can manually send the form at any time after the check has been created, using the link found in the form_uri attribute of the check object. Write-only. Defaults to false.
* @type {boolean}
* @memberof CheckRequest
*/
'suppress_form_emails'?: boolean;
/**
* Triggers responses for particular sub-results for sandbox Document reports.
* @type {string}
* @memberof CheckRequest
*/
'sub_result'?: string;
/**
* Array of names of particular reports to return consider as their results. This is a feature available in sandbox testing
* @type {Array<ReportName>}
* @memberof CheckRequest
*/
'consider'?: Array<ReportName>;
/**
*
* @type {UsDrivingLicenceBuilder}
* @memberof CheckRequest
*/
'us_driving_licence'?: UsDrivingLicenceBuilder;
}
/**
*
* @export
* @interface CheckResponse
*/
export interface CheckResponse {
/**
* The unique identifier for the check.
* @type {string}
* @memberof CheckResponse
*/
'id': string;
/**
* The date and time when this check was created.
* @type {string}
* @memberof CheckResponse
*/
'created_at'?: string;
/**
* The uri of this resource.
* @type {string}