verisec 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2212 @@
1
+ # Generated by script/generate from spec/openapi.json. Do not edit by hand.
2
+
3
+ module VeriSec
4
+ module Types
5
+ # FaceAnalyze: The full result of Face Analyze: everything the check found.
6
+ class FaceAnalyze < VeriSecObject
7
+ FIELDS: Hash[String, String?]
8
+ end
9
+
10
+ # FaceDetect: The answer of Face Detect.
11
+ class FaceDetect < VeriSecObject
12
+ FIELDS: Hash[String, String?]
13
+ def code: () -> Numeric?
14
+ def msg: () -> String?
15
+ def faceCount: () -> Numeric?
16
+ def faces: () -> Array[FaceDetectFace]?
17
+ def elapsedTime: () -> Numeric?
18
+ def metadata: () -> FaceDetectMetadata?
19
+ end
20
+
21
+ class FaceDetectFace < VeriSecObject
22
+ FIELDS: Hash[String, String?]
23
+ def roi: () -> Array[Numeric]?
24
+ def rotationAngle: () -> Numeric?
25
+ def landmarks: () -> Array[Array[Numeric]]?
26
+ end
27
+
28
+ class FaceDetectMetadata < VeriSecObject
29
+ FIELDS: Hash[String, String?]
30
+ def serverTime: () -> String?
31
+ def ctx: () -> FaceDetectMetadataCtx?
32
+ end
33
+
34
+ class FaceDetectMetadataCtx < VeriSecObject
35
+ FIELDS: Hash[String, String?]
36
+ def userIp: () -> String?
37
+ end
38
+
39
+ # FaceCount: The answer of Face Count.
40
+ class FaceCount < VeriSecObject
41
+ FIELDS: Hash[String, String?]
42
+ def code: () -> Numeric?
43
+ def msg: () -> String?
44
+ def faceCount: () -> Numeric?
45
+ def ok: () -> bool?
46
+ def rule: () -> String?
47
+ def faces: () -> Array[FaceCountFace]?
48
+ def elapsedTime: () -> Numeric?
49
+ def metadata: () -> FaceCountMetadata?
50
+ end
51
+
52
+ class FaceCountFace < VeriSecObject
53
+ FIELDS: Hash[String, String?]
54
+ def roi: () -> Array[Numeric]?
55
+ end
56
+
57
+ class FaceCountMetadata < VeriSecObject
58
+ FIELDS: Hash[String, String?]
59
+ def serverTime: () -> String?
60
+ def ctx: () -> FaceCountMetadataCtx?
61
+ end
62
+
63
+ class FaceCountMetadataCtx < VeriSecObject
64
+ FIELDS: Hash[String, String?]
65
+ def userIp: () -> String?
66
+ end
67
+
68
+ # FaceAttributes: The answer of Face Attributes.
69
+ class FaceAttributes < VeriSecObject
70
+ FIELDS: Hash[String, String?]
71
+ def code: () -> Numeric?
72
+ def msg: () -> String?
73
+ def faces: () -> Array[FaceAttributesFace]?
74
+ def elapsedTime: () -> Numeric?
75
+ def metadata: () -> FaceAttributesMetadata?
76
+ end
77
+
78
+ class FaceAttributesFace < VeriSecObject
79
+ FIELDS: Hash[String, String?]
80
+ def roi: () -> Array[Numeric]?
81
+ def attributes: () -> Array[FaceAttributesFaceAttribute]?
82
+ end
83
+
84
+ class FaceAttributesFaceAttribute < VeriSecObject
85
+ FIELDS: Hash[String, String?]
86
+ def name: () -> String?
87
+ def value: () -> untyped
88
+ def confidence: () -> Numeric?
89
+ end
90
+
91
+ class FaceAttributesMetadata < VeriSecObject
92
+ FIELDS: Hash[String, String?]
93
+ def serverTime: () -> String?
94
+ def ctx: () -> FaceAttributesMetadataCtx?
95
+ end
96
+
97
+ class FaceAttributesMetadataCtx < VeriSecObject
98
+ FIELDS: Hash[String, String?]
99
+ def userIp: () -> String?
100
+ end
101
+
102
+ # FacePpe: The answer of Mask & Glasses (PPE).
103
+ class FacePpe < VeriSecObject
104
+ FIELDS: Hash[String, String?]
105
+ def code: () -> Numeric?
106
+ def msg: () -> String?
107
+ def faces: () -> Array[FacePpeFace]?
108
+ def elapsedTime: () -> Numeric?
109
+ def metadata: () -> FacePpeMetadata?
110
+ end
111
+
112
+ class FacePpeFace < VeriSecObject
113
+ FIELDS: Hash[String, String?]
114
+ def roi: () -> Array[Numeric]?
115
+ def `MedicalMask`: () -> String?
116
+ def `Glasses`: () -> String?
117
+ def `HeadCovering`: () -> String?
118
+ def `Headphones`: () -> String?
119
+ end
120
+
121
+ class FacePpeMetadata < VeriSecObject
122
+ FIELDS: Hash[String, String?]
123
+ def serverTime: () -> String?
124
+ def ctx: () -> FacePpeMetadataCtx?
125
+ end
126
+
127
+ class FacePpeMetadataCtx < VeriSecObject
128
+ FIELDS: Hash[String, String?]
129
+ def userIp: () -> String?
130
+ end
131
+
132
+ # FaceEmotion: The answer of Emotion.
133
+ class FaceEmotion < VeriSecObject
134
+ FIELDS: Hash[String, String?]
135
+ def code: () -> Numeric?
136
+ def msg: () -> String?
137
+ def faces: () -> Array[FaceEmotionFace]?
138
+ def elapsedTime: () -> Numeric?
139
+ def metadata: () -> FaceEmotionMetadata?
140
+ end
141
+
142
+ class FaceEmotionFace < VeriSecObject
143
+ FIELDS: Hash[String, String?]
144
+ def roi: () -> Array[Numeric]?
145
+ def emotion: () -> String?
146
+ def confidence: () -> Numeric?
147
+ end
148
+
149
+ class FaceEmotionMetadata < VeriSecObject
150
+ FIELDS: Hash[String, String?]
151
+ def serverTime: () -> String?
152
+ def ctx: () -> FaceEmotionMetadataCtx?
153
+ end
154
+
155
+ class FaceEmotionMetadataCtx < VeriSecObject
156
+ FIELDS: Hash[String, String?]
157
+ def userIp: () -> String?
158
+ end
159
+
160
+ # FaceCrop: The answer of Smart Crop.
161
+ class FaceCrop < VeriSecObject
162
+ FIELDS: Hash[String, String?]
163
+ def code: () -> Numeric?
164
+ def msg: () -> String?
165
+ def crops: () -> Array[FaceCropCrop]?
166
+ def elapsedTime: () -> Numeric?
167
+ def metadata: () -> FaceCropMetadata?
168
+ end
169
+
170
+ class FaceCropCrop < VeriSecObject
171
+ FIELDS: Hash[String, String?]
172
+ def roi: () -> Array[Numeric]?
173
+ def rotationAngle: () -> Numeric?
174
+ def crop: () -> String?
175
+ end
176
+
177
+ class FaceCropMetadata < VeriSecObject
178
+ FIELDS: Hash[String, String?]
179
+ def serverTime: () -> String?
180
+ def ctx: () -> FaceCropMetadataCtx?
181
+ end
182
+
183
+ class FaceCropMetadataCtx < VeriSecObject
184
+ FIELDS: Hash[String, String?]
185
+ def userIp: () -> String?
186
+ end
187
+
188
+ # FaceRedact: The answer of Face Redact.
189
+ class FaceRedact < VeriSecObject
190
+ FIELDS: Hash[String, String?]
191
+ def code: () -> Numeric?
192
+ def msg: () -> String?
193
+ def faceCount: () -> Numeric?
194
+ def image: () -> String?
195
+ def boxes: () -> Array[Array[Numeric]]?
196
+ def elapsedTime: () -> Numeric?
197
+ def metadata: () -> FaceRedactMetadata?
198
+ end
199
+
200
+ class FaceRedactMetadata < VeriSecObject
201
+ FIELDS: Hash[String, String?]
202
+ def serverTime: () -> String?
203
+ def ctx: () -> FaceRedactMetadataCtx?
204
+ end
205
+
206
+ class FaceRedactMetadataCtx < VeriSecObject
207
+ FIELDS: Hash[String, String?]
208
+ def userIp: () -> String?
209
+ end
210
+
211
+ # FaceMatch: The full result of Face Match: everything the check found.
212
+ class FaceMatch < VeriSecObject
213
+ FIELDS: Hash[String, String?]
214
+ end
215
+
216
+ # FaceVerify: The answer of Face Verify (1:1).
217
+ class FaceVerify < VeriSecObject
218
+ FIELDS: Hash[String, String?]
219
+ def code: () -> Numeric?
220
+ def msg: () -> String?
221
+ def similarity: () -> Numeric?
222
+ def score: () -> Numeric?
223
+ def match: () -> bool?
224
+ def threshold: () -> Numeric?
225
+ def compared: () -> Array[FaceVerifyCompared]?
226
+ def elapsedTime: () -> Numeric?
227
+ def metadata: () -> FaceVerifyMetadata?
228
+ end
229
+
230
+ class FaceVerifyCompared < VeriSecObject
231
+ FIELDS: Hash[String, String?]
232
+ def image: () -> String?
233
+ def roi: () -> Array[Numeric]?
234
+ end
235
+
236
+ class FaceVerifyMetadata < VeriSecObject
237
+ FIELDS: Hash[String, String?]
238
+ def serverTime: () -> String?
239
+ def ctx: () -> FaceVerifyMetadataCtx?
240
+ end
241
+
242
+ class FaceVerifyMetadataCtx < VeriSecObject
243
+ FIELDS: Hash[String, String?]
244
+ def userIp: () -> String?
245
+ end
246
+
247
+ # FaceSimilarity: The answer of Similarity Score.
248
+ class FaceSimilarity < VeriSecObject
249
+ FIELDS: Hash[String, String?]
250
+ def code: () -> Numeric?
251
+ def msg: () -> String?
252
+ def similarity: () -> Numeric?
253
+ def score: () -> Numeric?
254
+ def compared: () -> Array[FaceSimilarityCompared]?
255
+ def elapsedTime: () -> Numeric?
256
+ def metadata: () -> FaceSimilarityMetadata?
257
+ end
258
+
259
+ class FaceSimilarityCompared < VeriSecObject
260
+ FIELDS: Hash[String, String?]
261
+ def image: () -> String?
262
+ def roi: () -> Array[Numeric]?
263
+ end
264
+
265
+ class FaceSimilarityMetadata < VeriSecObject
266
+ FIELDS: Hash[String, String?]
267
+ def serverTime: () -> String?
268
+ def ctx: () -> FaceSimilarityMetadataCtx?
269
+ end
270
+
271
+ class FaceSimilarityMetadataCtx < VeriSecObject
272
+ FIELDS: Hash[String, String?]
273
+ def userIp: () -> String?
274
+ end
275
+
276
+ # FaceSearch: The answer of Face Search (1:N).
277
+ class FaceSearch < VeriSecObject
278
+ FIELDS: Hash[String, String?]
279
+ def code: () -> Numeric?
280
+ def msg: () -> String?
281
+ def matches: () -> Array[FaceSearchMatch]?
282
+ def best: () -> FaceSearchBest?
283
+ def elapsedTime: () -> Numeric?
284
+ def metadata: () -> FaceSearchMetadata?
285
+ end
286
+
287
+ class FaceSearchMatch < VeriSecObject
288
+ FIELDS: Hash[String, String?]
289
+ def id: () -> String?
290
+ def similarity: () -> Numeric?
291
+ def rank: () -> Numeric?
292
+ end
293
+
294
+ class FaceSearchBest < VeriSecObject
295
+ FIELDS: Hash[String, String?]
296
+ def id: () -> String?
297
+ def similarity: () -> Numeric?
298
+ end
299
+
300
+ class FaceSearchMetadata < VeriSecObject
301
+ FIELDS: Hash[String, String?]
302
+ def serverTime: () -> String?
303
+ def ctx: () -> FaceSearchMetadataCtx?
304
+ end
305
+
306
+ class FaceSearchMetadataCtx < VeriSecObject
307
+ FIELDS: Hash[String, String?]
308
+ def userIp: () -> String?
309
+ end
310
+
311
+ # FaceDedupe: The answer of Duplicate Check.
312
+ class FaceDedupe < VeriSecObject
313
+ FIELDS: Hash[String, String?]
314
+ def code: () -> Numeric?
315
+ def msg: () -> String?
316
+ def duplicate: () -> bool?
317
+ def matchedId: () -> String?
318
+ def similarity: () -> Numeric?
319
+ def elapsedTime: () -> Numeric?
320
+ def metadata: () -> FaceDedupeMetadata?
321
+ end
322
+
323
+ class FaceDedupeMetadata < VeriSecObject
324
+ FIELDS: Hash[String, String?]
325
+ def serverTime: () -> String?
326
+ def ctx: () -> FaceDedupeMetadataCtx?
327
+ end
328
+
329
+ class FaceDedupeMetadataCtx < VeriSecObject
330
+ FIELDS: Hash[String, String?]
331
+ def userIp: () -> String?
332
+ end
333
+
334
+ # FaceWatchlist: The answer of Watchlist Screening.
335
+ class FaceWatchlist < VeriSecObject
336
+ FIELDS: Hash[String, String?]
337
+ def code: () -> Numeric?
338
+ def msg: () -> String?
339
+ def hit: () -> bool?
340
+ def entry: () -> FaceWatchlistEntry?
341
+ def elapsedTime: () -> Numeric?
342
+ def metadata: () -> FaceWatchlistMetadata?
343
+ end
344
+
345
+ class FaceWatchlistEntry < VeriSecObject
346
+ FIELDS: Hash[String, String?]
347
+ def id: () -> String?
348
+ def label: () -> String?
349
+ def similarity: () -> Numeric?
350
+ end
351
+
352
+ class FaceWatchlistMetadata < VeriSecObject
353
+ FIELDS: Hash[String, String?]
354
+ def serverTime: () -> String?
355
+ def ctx: () -> FaceWatchlistMetadataCtx?
356
+ end
357
+
358
+ class FaceWatchlistMetadataCtx < VeriSecObject
359
+ FIELDS: Hash[String, String?]
360
+ def userIp: () -> String?
361
+ end
362
+
363
+ # FaceCluster: The answer of Face Cluster.
364
+ class FaceCluster < VeriSecObject
365
+ FIELDS: Hash[String, String?]
366
+ def code: () -> Numeric?
367
+ def msg: () -> String?
368
+ def clusters: () -> Array[Array[String]]?
369
+ def pairs: () -> Array[FaceClusterPair]?
370
+ def elapsedTime: () -> Numeric?
371
+ def metadata: () -> FaceClusterMetadata?
372
+ end
373
+
374
+ class FaceClusterPair < VeriSecObject
375
+ FIELDS: Hash[String, String?]
376
+ def a: () -> String?
377
+ def b: () -> String?
378
+ def similarity: () -> Numeric?
379
+ end
380
+
381
+ class FaceClusterMetadata < VeriSecObject
382
+ FIELDS: Hash[String, String?]
383
+ def serverTime: () -> String?
384
+ def ctx: () -> FaceClusterMetadataCtx?
385
+ end
386
+
387
+ class FaceClusterMetadataCtx < VeriSecObject
388
+ FIELDS: Hash[String, String?]
389
+ def userIp: () -> String?
390
+ end
391
+
392
+ # FaceAge: The full result of Age Estimation: everything the check found.
393
+ class FaceAge < VeriSecObject
394
+ FIELDS: Hash[String, String?]
395
+ end
396
+
397
+ # AgeVerify: The answer of Age Check.
398
+ class AgeVerify < VeriSecObject
399
+ FIELDS: Hash[String, String?]
400
+ def code: () -> Numeric?
401
+ def msg: () -> String?
402
+ def age: () -> Array[Numeric]?
403
+ def allowed: () -> bool?
404
+ def minAge: () -> Numeric?
405
+ def basis: () -> String?
406
+ def elapsedTime: () -> Numeric?
407
+ def metadata: () -> AgeVerifyMetadata?
408
+ end
409
+
410
+ class AgeVerifyMetadata < VeriSecObject
411
+ FIELDS: Hash[String, String?]
412
+ def serverTime: () -> String?
413
+ def ctx: () -> AgeVerifyMetadataCtx?
414
+ end
415
+
416
+ class AgeVerifyMetadataCtx < VeriSecObject
417
+ FIELDS: Hash[String, String?]
418
+ def userIp: () -> String?
419
+ end
420
+
421
+ # AgeVerifyLive: The answer of Age Check + Liveness.
422
+ class AgeVerifyLive < VeriSecObject
423
+ FIELDS: Hash[String, String?]
424
+ def code: () -> Numeric?
425
+ def msg: () -> String?
426
+ def age: () -> Array[Numeric]?
427
+ def allowed: () -> bool?
428
+ def live: () -> bool?
429
+ def basis: () -> String?
430
+ def elapsedTime: () -> Numeric?
431
+ def metadata: () -> AgeVerifyLiveMetadata?
432
+ end
433
+
434
+ class AgeVerifyLiveMetadata < VeriSecObject
435
+ FIELDS: Hash[String, String?]
436
+ def serverTime: () -> String?
437
+ def ctx: () -> AgeVerifyLiveMetadataCtx?
438
+ end
439
+
440
+ class AgeVerifyLiveMetadataCtx < VeriSecObject
441
+ FIELDS: Hash[String, String?]
442
+ def userIp: () -> String?
443
+ end
444
+
445
+ # FaceQuality: The full result of Photo Quality: everything the check found.
446
+ class FaceQuality < VeriSecObject
447
+ FIELDS: Hash[String, String?]
448
+ end
449
+
450
+ # PhotoCompliance: The answer of Photo Compliance.
451
+ class PhotoCompliance < VeriSecObject
452
+ FIELDS: Hash[String, String?]
453
+ def code: () -> Numeric?
454
+ def msg: () -> String?
455
+ def compliant: () -> bool?
456
+ def nonCompliant: () -> Array[untyped]?
457
+ def checks: () -> Array[PhotoComplianceCheck]?
458
+ def standard: () -> String?
459
+ def elapsedTime: () -> Numeric?
460
+ def metadata: () -> PhotoComplianceMetadata?
461
+ end
462
+
463
+ class PhotoComplianceCheck < VeriSecObject
464
+ FIELDS: Hash[String, String?]
465
+ def groupId: () -> Numeric?
466
+ def name: () -> String?
467
+ def range: () -> Array[Numeric]?
468
+ def status: () -> Numeric?
469
+ def value: () -> Numeric?
470
+ end
471
+
472
+ class PhotoComplianceMetadata < VeriSecObject
473
+ FIELDS: Hash[String, String?]
474
+ def serverTime: () -> String?
475
+ def ctx: () -> PhotoComplianceMetadataCtx?
476
+ end
477
+
478
+ class PhotoComplianceMetadataCtx < VeriSecObject
479
+ FIELDS: Hash[String, String?]
480
+ def userIp: () -> String?
481
+ end
482
+
483
+ # PhotoPolicy: The answer of Photo Policy.
484
+ class PhotoPolicy < VeriSecObject
485
+ FIELDS: Hash[String, String?]
486
+ def code: () -> Numeric?
487
+ def msg: () -> String?
488
+ def pass: () -> bool?
489
+ def failed: () -> Array[untyped]?
490
+ def checks: () -> Array[PhotoPolicyCheck]?
491
+ def elapsedTime: () -> Numeric?
492
+ def metadata: () -> PhotoPolicyMetadata?
493
+ end
494
+
495
+ class PhotoPolicyCheck < VeriSecObject
496
+ FIELDS: Hash[String, String?]
497
+ def name: () -> String?
498
+ def range: () -> Array[Numeric]?
499
+ def value: () -> Numeric?
500
+ def status: () -> Numeric?
501
+ end
502
+
503
+ class PhotoPolicyMetadata < VeriSecObject
504
+ FIELDS: Hash[String, String?]
505
+ def serverTime: () -> String?
506
+ def ctx: () -> PhotoPolicyMetadataCtx?
507
+ end
508
+
509
+ class PhotoPolicyMetadataCtx < VeriSecObject
510
+ FIELDS: Hash[String, String?]
511
+ def userIp: () -> String?
512
+ end
513
+
514
+ # PhotoGate: The answer of Quality Gate.
515
+ class PhotoGate < VeriSecObject
516
+ FIELDS: Hash[String, String?]
517
+ def code: () -> Numeric?
518
+ def msg: () -> String?
519
+ def ok: () -> bool?
520
+ def failed: () -> Array[untyped]?
521
+ def elapsedTime: () -> Numeric?
522
+ def metadata: () -> PhotoGateMetadata?
523
+ end
524
+
525
+ class PhotoGateMetadata < VeriSecObject
526
+ FIELDS: Hash[String, String?]
527
+ def serverTime: () -> String?
528
+ def ctx: () -> PhotoGateMetadataCtx?
529
+ end
530
+
531
+ class PhotoGateMetadataCtx < VeriSecObject
532
+ FIELDS: Hash[String, String?]
533
+ def userIp: () -> String?
534
+ end
535
+
536
+ # PhotoAutofix: The answer of Photo Auto-fix.
537
+ class PhotoAutofix < VeriSecObject
538
+ FIELDS: Hash[String, String?]
539
+ def code: () -> Numeric?
540
+ def msg: () -> String?
541
+ def image: () -> String?
542
+ def aspect: () -> String?
543
+ def elapsedTime: () -> Numeric?
544
+ def metadata: () -> PhotoAutofixMetadata?
545
+ end
546
+
547
+ class PhotoAutofixMetadata < VeriSecObject
548
+ FIELDS: Hash[String, String?]
549
+ def serverTime: () -> String?
550
+ def ctx: () -> PhotoAutofixMetadataCtx?
551
+ end
552
+
553
+ class PhotoAutofixMetadataCtx < VeriSecObject
554
+ FIELDS: Hash[String, String?]
555
+ def userIp: () -> String?
556
+ end
557
+
558
+ # PhotoBestFrame: The answer of Best Frame.
559
+ class PhotoBestFrame < VeriSecObject
560
+ FIELDS: Hash[String, String?]
561
+ def code: () -> Numeric?
562
+ def msg: () -> String?
563
+ def bestIndex: () -> Numeric?
564
+ def ranking: () -> Array[PhotoBestFrameRanking]?
565
+ def elapsedTime: () -> Numeric?
566
+ def metadata: () -> PhotoBestFrameMetadata?
567
+ end
568
+
569
+ class PhotoBestFrameRanking < VeriSecObject
570
+ FIELDS: Hash[String, String?]
571
+ def index: () -> Numeric?
572
+ def compliant: () -> bool?
573
+ def failedCount: () -> untyped
574
+ end
575
+
576
+ class PhotoBestFrameMetadata < VeriSecObject
577
+ FIELDS: Hash[String, String?]
578
+ def serverTime: () -> String?
579
+ def ctx: () -> PhotoBestFrameMetadataCtx?
580
+ end
581
+
582
+ class PhotoBestFrameMetadataCtx < VeriSecObject
583
+ FIELDS: Hash[String, String?]
584
+ def userIp: () -> String?
585
+ end
586
+
587
+ # LivenessCheck: The full result of Liveness: everything the check found.
588
+ class LivenessCheck < VeriSecObject
589
+ FIELDS: Hash[String, String?]
590
+ end
591
+
592
+ # LivenessAntispoof: The answer of Anti-spoof Reason.
593
+ class LivenessAntispoof < VeriSecObject
594
+ FIELDS: Hash[String, String?]
595
+ def code: () -> Numeric?
596
+ def live: () -> bool?
597
+ def reason: () -> String?
598
+ def reasonCode: () -> Numeric?
599
+ def category: () -> String?
600
+ def elapsedTime: () -> Numeric?
601
+ def metadata: () -> LivenessAntispoofMetadata?
602
+ end
603
+
604
+ class LivenessAntispoofMetadata < VeriSecObject
605
+ FIELDS: Hash[String, String?]
606
+ def elapsedTime: () -> Numeric?
607
+ def serverTime: () -> String?
608
+ def ctx: () -> LivenessAntispoofMetadataCtx?
609
+ end
610
+
611
+ class LivenessAntispoofMetadataCtx < VeriSecObject
612
+ FIELDS: Hash[String, String?]
613
+ def userIp: () -> String?
614
+ end
615
+
616
+ # LivenessGate: The answer of Liveness Gate.
617
+ class LivenessGate < VeriSecObject
618
+ FIELDS: Hash[String, String?]
619
+ def code: () -> Numeric?
620
+ def pass: () -> bool?
621
+ def status: () -> Numeric?
622
+ def elapsedTime: () -> Numeric?
623
+ def metadata: () -> LivenessGateMetadata?
624
+ end
625
+
626
+ class LivenessGateMetadata < VeriSecObject
627
+ FIELDS: Hash[String, String?]
628
+ def elapsedTime: () -> Numeric?
629
+ def serverTime: () -> String?
630
+ def ctx: () -> LivenessGateMetadataCtx?
631
+ end
632
+
633
+ class LivenessGateMetadataCtx < VeriSecObject
634
+ FIELDS: Hash[String, String?]
635
+ def userIp: () -> String?
636
+ end
637
+
638
+ # IdentityVerify: The answer of Identity Verification.
639
+ class IdentityVerify < VeriSecObject
640
+ FIELDS: Hash[String, String?]
641
+ def code: () -> Numeric?
642
+ def msg: () -> String?
643
+ def verified: () -> bool?
644
+ def live: () -> bool?
645
+ def qualityOk: () -> bool?
646
+ def similarity: () -> Numeric?
647
+ def steps: () -> IdentityVerifySteps?
648
+ def elapsedTime: () -> Numeric?
649
+ def metadata: () -> IdentityVerifyMetadata?
650
+ end
651
+
652
+ class IdentityVerifySteps < VeriSecObject
653
+ FIELDS: Hash[String, String?]
654
+ def liveness: () -> IdentityVerifyStepsLiveness?
655
+ def quality: () -> IdentityVerifyStepsQuality?
656
+ def match: () -> IdentityVerifyStepsMatch?
657
+ end
658
+
659
+ class IdentityVerifyStepsLiveness < VeriSecObject
660
+ FIELDS: Hash[String, String?]
661
+ def live: () -> bool?
662
+ def status: () -> Numeric?
663
+ def reasonCode: () -> Numeric?
664
+ end
665
+
666
+ class IdentityVerifyStepsQuality < VeriSecObject
667
+ FIELDS: Hash[String, String?]
668
+ def ok: () -> bool?
669
+ def failed: () -> Array[String]?
670
+ def checked: () -> Array[String]?
671
+ end
672
+
673
+ class IdentityVerifyStepsMatch < VeriSecObject
674
+ FIELDS: Hash[String, String?]
675
+ def similarity: () -> Numeric?
676
+ def score: () -> Numeric?
677
+ def match: () -> bool?
678
+ def threshold: () -> Numeric?
679
+ end
680
+
681
+ class IdentityVerifyMetadata < VeriSecObject
682
+ FIELDS: Hash[String, String?]
683
+ def serverTime: () -> String?
684
+ def ctx: () -> IdentityVerifyMetadataCtx?
685
+ end
686
+
687
+ class IdentityVerifyMetadataCtx < VeriSecObject
688
+ FIELDS: Hash[String, String?]
689
+ def userIp: () -> String?
690
+ end
691
+
692
+ # FaceLoginAuthenticate: The answer of Face Login.
693
+ class FaceLoginAuthenticate < VeriSecObject
694
+ FIELDS: Hash[String, String?]
695
+ def code: () -> Numeric?
696
+ def msg: () -> String?
697
+ def authenticated: () -> bool?
698
+ def userId: () -> untyped
699
+ def similarity: () -> Numeric?
700
+ def live: () -> bool?
701
+ def elapsedTime: () -> Numeric?
702
+ def metadata: () -> FaceLoginAuthenticateMetadata?
703
+ end
704
+
705
+ class FaceLoginAuthenticateMetadata < VeriSecObject
706
+ FIELDS: Hash[String, String?]
707
+ def serverTime: () -> String?
708
+ def ctx: () -> FaceLoginAuthenticateMetadataCtx?
709
+ end
710
+
711
+ class FaceLoginAuthenticateMetadataCtx < VeriSecObject
712
+ FIELDS: Hash[String, String?]
713
+ def userIp: () -> String?
714
+ end
715
+
716
+ # FraudSignupCheck: The answer of Sign-up Fraud Check.
717
+ class FraudSignupCheck < VeriSecObject
718
+ FIELDS: Hash[String, String?]
719
+ def code: () -> Numeric?
720
+ def msg: () -> String?
721
+ def allow: () -> bool?
722
+ def reason: () -> String?
723
+ def matchedId: () -> String?
724
+ def live: () -> bool?
725
+ def elapsedTime: () -> Numeric?
726
+ def metadata: () -> FraudSignupCheckMetadata?
727
+ end
728
+
729
+ class FraudSignupCheckMetadata < VeriSecObject
730
+ FIELDS: Hash[String, String?]
731
+ def serverTime: () -> String?
732
+ def ctx: () -> FraudSignupCheckMetadataCtx?
733
+ end
734
+
735
+ class FraudSignupCheckMetadataCtx < VeriSecObject
736
+ FIELDS: Hash[String, String?]
737
+ def userIp: () -> String?
738
+ end
739
+
740
+ # ProctorCheck: The answer of Proctoring Check.
741
+ class ProctorCheck < VeriSecObject
742
+ FIELDS: Hash[String, String?]
743
+ def code: () -> Numeric?
744
+ def msg: () -> String?
745
+ def ok: () -> bool?
746
+ def live: () -> bool?
747
+ def faceCount: () -> Numeric?
748
+ def offGaze: () -> Numeric?
749
+ def lookingAway: () -> bool?
750
+ def maskWorn: () -> bool?
751
+ def elapsedTime: () -> Numeric?
752
+ def metadata: () -> ProctorCheckMetadata?
753
+ end
754
+
755
+ class ProctorCheckMetadata < VeriSecObject
756
+ FIELDS: Hash[String, String?]
757
+ def serverTime: () -> String?
758
+ def ctx: () -> ProctorCheckMetadataCtx?
759
+ end
760
+
761
+ class ProctorCheckMetadataCtx < VeriSecObject
762
+ FIELDS: Hash[String, String?]
763
+ def userIp: () -> String?
764
+ end
765
+
766
+ # AgeGateCheckout: The answer of Age-gated Checkout.
767
+ class AgeGateCheckout < VeriSecObject
768
+ FIELDS: Hash[String, String?]
769
+ def code: () -> Numeric?
770
+ def msg: () -> String?
771
+ def allowed: () -> bool?
772
+ def age: () -> Array[Numeric]?
773
+ def live: () -> bool?
774
+ def elapsedTime: () -> Numeric?
775
+ def metadata: () -> AgeGateCheckoutMetadata?
776
+ end
777
+
778
+ class AgeGateCheckoutMetadata < VeriSecObject
779
+ FIELDS: Hash[String, String?]
780
+ def serverTime: () -> String?
781
+ def ctx: () -> AgeGateCheckoutMetadataCtx?
782
+ end
783
+
784
+ class AgeGateCheckoutMetadataCtx < VeriSecObject
785
+ FIELDS: Hash[String, String?]
786
+ def userIp: () -> String?
787
+ end
788
+
789
+ # KioskPhoto: The answer of Photo Kiosk.
790
+ class KioskPhoto < VeriSecObject
791
+ FIELDS: Hash[String, String?]
792
+ def code: () -> Numeric?
793
+ def msg: () -> String?
794
+ def compliant: () -> bool?
795
+ def nonCompliant: () -> Array[untyped]?
796
+ def fixedImage: () -> String?
797
+ def printReady: () -> bool?
798
+ def elapsedTime: () -> Numeric?
799
+ def metadata: () -> KioskPhotoMetadata?
800
+ end
801
+
802
+ class KioskPhotoMetadata < VeriSecObject
803
+ FIELDS: Hash[String, String?]
804
+ def serverTime: () -> String?
805
+ def ctx: () -> KioskPhotoMetadataCtx?
806
+ end
807
+
808
+ class KioskPhotoMetadataCtx < VeriSecObject
809
+ FIELDS: Hash[String, String?]
810
+ def userIp: () -> String?
811
+ end
812
+
813
+ # DocumentRead: The full result of Document Read: everything the check found.
814
+ class DocumentRead < VeriSecObject
815
+ FIELDS: Hash[String, String?]
816
+ end
817
+
818
+ # DocumentClassify: The answer of Document Classify.
819
+ class DocumentClassify < VeriSecObject
820
+ FIELDS: Hash[String, String?]
821
+ def document_name: () -> String?
822
+ def doc_type: () -> String?
823
+ def category: () -> String?
824
+ def country: () -> String?
825
+ def country_name: () -> String?
826
+ def state: () -> untyped
827
+ def year: () -> String?
828
+ def size: () -> String?
829
+ def has_mrz: () -> bool?
830
+ def has_chip: () -> bool?
831
+ def deprecated: () -> bool?
832
+ def confidence: () -> Numeric?
833
+ end
834
+
835
+ # DocumentMrz: The answer of Document MRZ.
836
+ class DocumentMrz < VeriSecObject
837
+ FIELDS: Hash[String, String?]
838
+ def lines: () -> Array[String]?
839
+ def format: () -> String?
840
+ def valid: () -> bool?
841
+ def expired: () -> bool?
842
+ def problems: () -> Array[DocumentMrzProblem]?
843
+ def check_digits: () -> DocumentMrzCheckDigits?
844
+ def print_quality: () -> DocumentMrzPrintQuality?
845
+ def parsed: () -> DocumentMrzParsed?
846
+ end
847
+
848
+ class DocumentMrzProblem < VeriSecObject
849
+ FIELDS: Hash[String, String?]
850
+ def field: () -> String?
851
+ def issue: () -> String?
852
+ end
853
+
854
+ class DocumentMrzCheckDigits < VeriSecObject
855
+ FIELDS: Hash[String, String?]
856
+ def doc_number: () -> DocumentMrzCheckDigitsDocNumber?
857
+ def birth_date: () -> DocumentMrzCheckDigitsBirthDate?
858
+ def expiry: () -> DocumentMrzCheckDigitsExpiry?
859
+ def personal_number: () -> DocumentMrzCheckDigitsPersonalNumber?
860
+ def composite: () -> DocumentMrzCheckDigitsComposite?
861
+ end
862
+
863
+ class DocumentMrzCheckDigitsDocNumber < VeriSecObject
864
+ FIELDS: Hash[String, String?]
865
+ def digit: () -> String?
866
+ def ok: () -> bool?
867
+ end
868
+
869
+ class DocumentMrzCheckDigitsBirthDate < VeriSecObject
870
+ FIELDS: Hash[String, String?]
871
+ def digit: () -> String?
872
+ def ok: () -> bool?
873
+ end
874
+
875
+ class DocumentMrzCheckDigitsExpiry < VeriSecObject
876
+ FIELDS: Hash[String, String?]
877
+ def digit: () -> String?
878
+ def ok: () -> bool?
879
+ end
880
+
881
+ class DocumentMrzCheckDigitsPersonalNumber < VeriSecObject
882
+ FIELDS: Hash[String, String?]
883
+ def digit: () -> String?
884
+ def ok: () -> bool?
885
+ end
886
+
887
+ class DocumentMrzCheckDigitsComposite < VeriSecObject
888
+ FIELDS: Hash[String, String?]
889
+ def digit: () -> String?
890
+ def ok: () -> bool?
891
+ end
892
+
893
+ class DocumentMrzPrintQuality < VeriSecObject
894
+ FIELDS: Hash[String, String?]
895
+ def check_sums: () -> String?
896
+ def contrast: () -> String?
897
+ def doc_format: () -> String?
898
+ def mrz_format: () -> String?
899
+ def print_position: () -> String?
900
+ def stains: () -> String?
901
+ def symbols: () -> String?
902
+ end
903
+
904
+ class DocumentMrzParsed < VeriSecObject
905
+ FIELDS: Hash[String, String?]
906
+ def `RemainderTerm`: () -> String?
907
+ def `Surname`: () -> String?
908
+ def `Sex`: () -> String?
909
+ end
910
+
911
+ # DocumentPortrait: The answer of Document Portrait.
912
+ class DocumentPortrait < VeriSecObject
913
+ FIELDS: Hash[String, String?]
914
+ def portrait_ref: () -> String?
915
+ def face_detected: () -> bool?
916
+ def faces_on_document: () -> Numeric?
917
+ def face_confidence: () -> Numeric?
918
+ def portrait: () -> String?
919
+ end
920
+
921
+ # DocumentAuthenticity: The answer of Document Authenticity.
922
+ class DocumentAuthenticity < VeriSecObject
923
+ FIELDS: Hash[String, String?]
924
+ def overall: () -> String?
925
+ def failed: () -> Array[String]?
926
+ def summary: () -> DocumentAuthenticitySummary?
927
+ def checks: () -> Array[DocumentAuthenticityCheck]?
928
+ def image_quality: () -> DocumentAuthenticityImageQuality?
929
+ end
930
+
931
+ class DocumentAuthenticitySummary < VeriSecObject
932
+ FIELDS: Hash[String, String?]
933
+ def pass: () -> Numeric?
934
+ def fail: () -> Numeric?
935
+ def not_checked: () -> Numeric?
936
+ end
937
+
938
+ class DocumentAuthenticityCheck < VeriSecObject
939
+ FIELDS: Hash[String, String?]
940
+ def name: () -> String?
941
+ def status: () -> String?
942
+ end
943
+
944
+ class DocumentAuthenticityImageQuality < VeriSecObject
945
+ FIELDS: Hash[String, String?]
946
+ def focus: () -> String?
947
+ def glare: () -> String?
948
+ def portrait: () -> String?
949
+ def bounds: () -> String?
950
+ def perspective: () -> String?
951
+ def resolution: () -> String?
952
+ end
953
+
954
+ # DocumentFields: The answer of Document Fields.
955
+ class DocumentFields < VeriSecObject
956
+ FIELDS: Hash[String, String?]
957
+ def date_format: () -> String?
958
+ def count: () -> Numeric?
959
+ def summary: () -> DocumentFieldsSummary?
960
+ def fields: () -> Array[DocumentFieldsField]?
961
+ end
962
+
963
+ class DocumentFieldsSummary < VeriSecObject
964
+ FIELDS: Hash[String, String?]
965
+ def pass: () -> Numeric?
966
+ def fail: () -> Numeric?
967
+ def not_checked: () -> Numeric?
968
+ def sources_disagree: () -> Numeric?
969
+ end
970
+
971
+ class DocumentFieldsField < VeriSecObject
972
+ FIELDS: Hash[String, String?]
973
+ def `type`: () -> Numeric?
974
+ def label: () -> String?
975
+ def status: () -> String?
976
+ def sources: () -> Array[String]?
977
+ def sources_agree: () -> String?
978
+ def value_masked: () -> String?
979
+ end
980
+
981
+ # ProofOfAddressAnalyze: The full result of Proof of Address: everything the check found.
982
+ class ProofOfAddressAnalyze < VeriSecObject
983
+ FIELDS: Hash[String, String?]
984
+ end
985
+
986
+ # MrzRead: The full result of MRZ Read: everything the check found.
987
+ class MrzRead < VeriSecObject
988
+ FIELDS: Hash[String, String?]
989
+ end
990
+
991
+ # MrzRecognize: The answer of MRZ Recognize.
992
+ class MrzRecognize < VeriSecObject
993
+ FIELDS: Hash[String, String?]
994
+ def lines: () -> Array[String]?
995
+ def warped_box: () -> Array[Numeric]?
996
+ def confidence: () -> Array[Numeric]?
997
+ end
998
+
999
+ # MrzParse: The answer of MRZ Parse.
1000
+ class MrzParse < VeriSecObject
1001
+ FIELDS: Hash[String, String?]
1002
+ def format: () -> String?
1003
+ def valid: () -> bool?
1004
+ def expired: () -> bool?
1005
+ def problems: () -> Array[untyped]?
1006
+ def parsed: () -> MrzParseParsed?
1007
+ end
1008
+
1009
+ class MrzParseParsed < VeriSecObject
1010
+ FIELDS: Hash[String, String?]
1011
+ def doc: () -> String?
1012
+ def country: () -> String?
1013
+ def surname: () -> String?
1014
+ def given_name: () -> String?
1015
+ def doc_number: () -> String?
1016
+ def nationality: () -> String?
1017
+ def birth_date: () -> String?
1018
+ def sex: () -> String?
1019
+ def expiry: () -> String?
1020
+ def personal_number: () -> String?
1021
+ def check_digits: () -> MrzParseParsedCheckDigits?
1022
+ end
1023
+
1024
+ class MrzParseParsedCheckDigits < VeriSecObject
1025
+ FIELDS: Hash[String, String?]
1026
+ def doc_number: () -> MrzParseParsedCheckDigitsDocNumber?
1027
+ def birth_date: () -> MrzParseParsedCheckDigitsBirthDate?
1028
+ def expiry: () -> MrzParseParsedCheckDigitsExpiry?
1029
+ def personal_number: () -> MrzParseParsedCheckDigitsPersonalNumber?
1030
+ def composite: () -> MrzParseParsedCheckDigitsComposite?
1031
+ end
1032
+
1033
+ class MrzParseParsedCheckDigitsDocNumber < VeriSecObject
1034
+ FIELDS: Hash[String, String?]
1035
+ def digit: () -> String?
1036
+ def ok: () -> bool?
1037
+ end
1038
+
1039
+ class MrzParseParsedCheckDigitsBirthDate < VeriSecObject
1040
+ FIELDS: Hash[String, String?]
1041
+ def digit: () -> String?
1042
+ def ok: () -> bool?
1043
+ end
1044
+
1045
+ class MrzParseParsedCheckDigitsExpiry < VeriSecObject
1046
+ FIELDS: Hash[String, String?]
1047
+ def digit: () -> String?
1048
+ def ok: () -> bool?
1049
+ end
1050
+
1051
+ class MrzParseParsedCheckDigitsPersonalNumber < VeriSecObject
1052
+ FIELDS: Hash[String, String?]
1053
+ def digit: () -> String?
1054
+ def ok: () -> bool?
1055
+ end
1056
+
1057
+ class MrzParseParsedCheckDigitsComposite < VeriSecObject
1058
+ FIELDS: Hash[String, String?]
1059
+ def digit: () -> String?
1060
+ def ok: () -> bool?
1061
+ end
1062
+
1063
+ # EmailVerify: The answer of Email Risk.
1064
+ class EmailVerify < VeriSecObject
1065
+ FIELDS: Hash[String, String?]
1066
+ def email: () -> String?
1067
+ def domain: () -> String?
1068
+ def syntax_ok: () -> bool?
1069
+ def suggestion: () -> untyped
1070
+ def disposable: () -> bool?
1071
+ def free_provider: () -> bool?
1072
+ def mail_server: () -> EmailVerifyMailServer?
1073
+ def mailbox: () -> String?
1074
+ def deliverable: () -> String?
1075
+ def risk: () -> EmailVerifyRisk?
1076
+ end
1077
+
1078
+ class EmailVerifyMailServer < VeriSecObject
1079
+ FIELDS: Hash[String, String?]
1080
+ def found: () -> bool?
1081
+ def hosts: () -> Array[String]?
1082
+ end
1083
+
1084
+ class EmailVerifyRisk < VeriSecObject
1085
+ FIELDS: Hash[String, String?]
1086
+ def level: () -> String?
1087
+ def reasons: () -> Array[untyped]?
1088
+ end
1089
+
1090
+ # EmailFootprint: The answer of Email Accounts.
1091
+ class EmailFootprint < VeriSecObject
1092
+ FIELDS: Hash[String, String?]
1093
+ def email: () -> String?
1094
+ def count: () -> Numeric?
1095
+ def accounts: () -> Array[EmailFootprintAccount]?
1096
+ end
1097
+
1098
+ class EmailFootprintAccount < VeriSecObject
1099
+ FIELDS: Hash[String, String?]
1100
+ def site: () -> String?
1101
+ def domain: () -> String?
1102
+ def recovery_email_hint: () -> untyped
1103
+ def phone_hint: () -> untyped
1104
+ end
1105
+
1106
+ # OsintUsername: The answer of Username Search.
1107
+ class OsintUsername < VeriSecObject
1108
+ FIELDS: Hash[String, String?]
1109
+ def username: () -> String?
1110
+ def found: () -> Numeric?
1111
+ def common: () -> bool?
1112
+ def profiles: () -> Array[OsintUsernameProfile]?
1113
+ def left_out: () -> Numeric?
1114
+ end
1115
+
1116
+ class OsintUsernameProfile < VeriSecObject
1117
+ FIELDS: Hash[String, String?]
1118
+ def site: () -> String?
1119
+ def url: () -> String?
1120
+ end
1121
+
1122
+ # PhoneLookup: The answer of Phone Intelligence.
1123
+ class PhoneLookup < VeriSecObject
1124
+ FIELDS: Hash[String, String?]
1125
+ def phone: () -> String?
1126
+ def valid: () -> bool?
1127
+ def format: () -> PhoneLookupFormat?
1128
+ def country: () -> PhoneLookupCountry?
1129
+ def location: () -> untyped
1130
+ def line: () -> PhoneLookupLine?
1131
+ def status: () -> String?
1132
+ def sms_pumping: () -> PhoneLookupSmsPumping?
1133
+ def sim_swap: () -> PhoneLookupSimSwap?
1134
+ def call_forwarding: () -> PhoneLookupCallForwarding?
1135
+ def caller: () -> PhoneLookupCaller?
1136
+ def risk: () -> PhoneLookupRisk?
1137
+ end
1138
+
1139
+ class PhoneLookupFormat < VeriSecObject
1140
+ FIELDS: Hash[String, String?]
1141
+ def e164: () -> String?
1142
+ def national: () -> String?
1143
+ def international: () -> String?
1144
+ end
1145
+
1146
+ class PhoneLookupCountry < VeriSecObject
1147
+ FIELDS: Hash[String, String?]
1148
+ def code: () -> String?
1149
+ def name: () -> String?
1150
+ def calling_code: () -> String?
1151
+ end
1152
+
1153
+ class PhoneLookupLine < VeriSecObject
1154
+ FIELDS: Hash[String, String?]
1155
+ def `type`: () -> String?
1156
+ def carrier: () -> String?
1157
+ def mcc: () -> String?
1158
+ def mnc: () -> String?
1159
+ end
1160
+
1161
+ class PhoneLookupSmsPumping < VeriSecObject
1162
+ FIELDS: Hash[String, String?]
1163
+ def score: () -> Numeric?
1164
+ def carrier_risk: () -> String?
1165
+ def blocked: () -> bool?
1166
+ def blocked_on: () -> untyped
1167
+ def blocked_last_3_months: () -> bool?
1168
+ end
1169
+
1170
+ class PhoneLookupSimSwap < VeriSecObject
1171
+ FIELDS: Hash[String, String?]
1172
+ def available: () -> bool?
1173
+ def reason: () -> String?
1174
+ end
1175
+
1176
+ class PhoneLookupCallForwarding < VeriSecObject
1177
+ FIELDS: Hash[String, String?]
1178
+ def available: () -> bool?
1179
+ def reason: () -> String?
1180
+ end
1181
+
1182
+ class PhoneLookupCaller < VeriSecObject
1183
+ FIELDS: Hash[String, String?]
1184
+ def available: () -> bool?
1185
+ def reason: () -> String?
1186
+ end
1187
+
1188
+ class PhoneLookupRisk < VeriSecObject
1189
+ FIELDS: Hash[String, String?]
1190
+ def level: () -> String?
1191
+ def reasons: () -> Array[untyped]?
1192
+ end
1193
+
1194
+ # PhoneOtpSend: The answer of Send Phone Code.
1195
+ class PhoneOtpSend < VeriSecObject
1196
+ FIELDS: Hash[String, String?]
1197
+ def status: () -> String?
1198
+ def to: () -> String?
1199
+ def channel: () -> String?
1200
+ end
1201
+
1202
+ # PhoneOtpCheck: The answer of Check Phone Code.
1203
+ class PhoneOtpCheck < VeriSecObject
1204
+ FIELDS: Hash[String, String?]
1205
+ def status: () -> String?
1206
+ def valid: () -> bool?
1207
+ end
1208
+
1209
+ # ScreeningIp: The full result of IP Risk: everything the check found.
1210
+ class ScreeningIp < VeriSecObject
1211
+ FIELDS: Hash[String, String?]
1212
+ end
1213
+
1214
+ # IpAnalyze: The answer of IP Anonymity.
1215
+ class IpAnalyze < VeriSecObject
1216
+ FIELDS: Hash[String, String?]
1217
+ def ip: () -> String?
1218
+ def version: () -> Numeric?
1219
+ def `private`: () -> bool?
1220
+ def location: () -> IpAnalyzeLocation?
1221
+ def network: () -> IpAnalyzeNetwork?
1222
+ def anonymity: () -> IpAnalyzeAnonymity?
1223
+ def lists_updated: () -> String?
1224
+ end
1225
+
1226
+ class IpAnalyzeLocation < VeriSecObject
1227
+ FIELDS: Hash[String, String?]
1228
+ def continent: () -> String?
1229
+ def country_code: () -> String?
1230
+ def country: () -> String?
1231
+ def region: () -> String?
1232
+ def city: () -> String?
1233
+ def coordinates: () -> IpAnalyzeLocationCoordinates?
1234
+ def timezones: () -> Array[String]?
1235
+ end
1236
+
1237
+ class IpAnalyzeLocationCoordinates < VeriSecObject
1238
+ FIELDS: Hash[String, String?]
1239
+ def lat: () -> Numeric?
1240
+ def lon: () -> Numeric?
1241
+ end
1242
+
1243
+ class IpAnalyzeNetwork < VeriSecObject
1244
+ FIELDS: Hash[String, String?]
1245
+ def asn: () -> Numeric?
1246
+ def organization: () -> String?
1247
+ def connection_type: () -> String?
1248
+ end
1249
+
1250
+ class IpAnalyzeAnonymity < VeriSecObject
1251
+ FIELDS: Hash[String, String?]
1252
+ def tor: () -> bool?
1253
+ def vpn: () -> bool?
1254
+ def datacenter: () -> bool?
1255
+ def cloud_provider: () -> untyped
1256
+ def private_relay: () -> bool?
1257
+ def relay_region: () -> untyped
1258
+ def blocklisted: () -> bool?
1259
+ end
1260
+
1261
+ # ScreeningSanctions: The full result of Sanctions & PEP Screening: everything the check found.
1262
+ class ScreeningSanctions < VeriSecObject
1263
+ FIELDS: Hash[String, String?]
1264
+ end
1265
+
1266
+ # OsintWeb: The answer of Adverse Media.
1267
+ class OsintWeb < VeriSecObject
1268
+ FIELDS: Hash[String, String?]
1269
+ def query: () -> String?
1270
+ def mode: () -> String?
1271
+ def complete: () -> bool?
1272
+ def count: () -> Numeric?
1273
+ def results: () -> Array[OsintWebResult]?
1274
+ def left_out: () -> OsintWebLeftOut?
1275
+ end
1276
+
1277
+ class OsintWebResult < VeriSecObject
1278
+ FIELDS: Hash[String, String?]
1279
+ def title: () -> String?
1280
+ def site: () -> String?
1281
+ def url: () -> String?
1282
+ def date: () -> String?
1283
+ def topics: () -> Array[String]?
1284
+ def snippet: () -> String?
1285
+ end
1286
+
1287
+ class OsintWebLeftOut < VeriSecObject
1288
+ FIELDS: Hash[String, String?]
1289
+ def not_about_this_name: () -> Numeric?
1290
+ def not_adverse: () -> Numeric?
1291
+ def list_entries: () -> Numeric?
1292
+ end
1293
+
1294
+ # ScreeningCrypto: The answer of Wallet Screening.
1295
+ class ScreeningCrypto < VeriSecObject
1296
+ FIELDS: Hash[String, String?]
1297
+ def checked: () -> Numeric?
1298
+ def counts: () -> ScreeningCryptoCounts?
1299
+ def results: () -> Array[ScreeningCryptoResult]?
1300
+ end
1301
+
1302
+ class ScreeningCryptoCounts < VeriSecObject
1303
+ FIELDS: Hash[String, String?]
1304
+ def high: () -> Numeric?
1305
+ def medium: () -> Numeric?
1306
+ def low: () -> Numeric?
1307
+ def no_record: () -> Numeric?
1308
+ def unreadable: () -> Numeric?
1309
+ def invalid_address: () -> Numeric?
1310
+ def unrecognised: () -> Numeric?
1311
+ def disputed_listing: () -> Numeric?
1312
+ end
1313
+
1314
+ class ScreeningCryptoResult < VeriSecObject
1315
+ FIELDS: Hash[String, String?]
1316
+ def address: () -> String?
1317
+ def network: () -> untyped
1318
+ def valid_format: () -> untyped
1319
+ def checksum_ok: () -> untyped
1320
+ def format_note: () -> String?
1321
+ def verdict: () -> String?
1322
+ def risk: () -> String?
1323
+ def summary: () -> untyped
1324
+ def flags: () -> Array[untyped]?
1325
+ def listings: () -> Array[ScreeningCryptoResultListing]?
1326
+ def disputed_by: () -> Array[untyped]?
1327
+ def schemes: () -> Array[untyped]?
1328
+ def labels: () -> Array[ScreeningCryptoResultLabel]?
1329
+ end
1330
+
1331
+ class ScreeningCryptoResultListing < VeriSecObject
1332
+ FIELDS: Hash[String, String?]
1333
+ def network: () -> String?
1334
+ def categories: () -> Array[String]?
1335
+ def risk_class: () -> String?
1336
+ def subcategory: () -> untyped
1337
+ def victim_contract: () -> bool?
1338
+ end
1339
+
1340
+ class ScreeningCryptoResultLabel < VeriSecObject
1341
+ FIELDS: Hash[String, String?]
1342
+ def network: () -> String?
1343
+ def label: () -> String?
1344
+ end
1345
+
1346
+ # ContactDossier: The full result of Contact Dossier: everything the check found.
1347
+ class ContactDossier < VeriSecObject
1348
+ FIELDS: Hash[String, String?]
1349
+ end
1350
+
1351
+ # ChequeDeepRead: The whole cheque: the MICR read, what the face says, the bank, country and currency.
1352
+ class ChequeDeepRead < VeriSecObject
1353
+ FIELDS: Hash[String, String?]
1354
+ def id: () -> String
1355
+ def object: () -> String
1356
+ def created_at: () -> String
1357
+ def source: () -> String
1358
+ def env: () -> String
1359
+ def processing_ms: () -> Integer
1360
+ def image: () -> ChequeDeepReadImage
1361
+ def status: () -> String
1362
+ def micr: () -> ChequeResponse
1363
+ def vision: () -> VisionResult?
1364
+ def bank: () -> BankMatch?
1365
+ def currency: () -> ResolvedCurrency?
1366
+ def country: () -> CountryInfo?
1367
+ def reader_error: () -> String?
1368
+ def text_boxes: () -> TextBoxes?
1369
+ def cheques: () -> Array[DeepCheque]?
1370
+ def timing: () -> ChequeDeepReadTiming?
1371
+ def image_quality: () -> ChequeDeepReadImageQuality?
1372
+ end
1373
+
1374
+ class ChequeDeepReadImage < VeriSecObject
1375
+ FIELDS: Hash[String, String?]
1376
+ def width: () -> Integer
1377
+ def height: () -> Integer
1378
+ def url: () -> String
1379
+ end
1380
+
1381
+ # ChequeResponse: A cheque's MICR read (the MICR service's wire format).
1382
+ class ChequeResponse < VeriSecObject
1383
+ FIELDS: Hash[String, String?]
1384
+ def id: () -> String
1385
+ def object: () -> String
1386
+ def created_at: () -> String
1387
+ def source: () -> String
1388
+ def env: () -> String
1389
+ def processing_ms: () -> Integer
1390
+ def status: () -> String
1391
+ def issue_code: () -> String?
1392
+ def issue: () -> String?
1393
+ def image: () -> ChequeResponseImage
1394
+ def zones_detected: () -> Integer
1395
+ def zones: () -> Array[MicrZone]
1396
+ def micr: () -> MicrZone?
1397
+ def quality: () -> ChequeResponseQuality
1398
+ def country: () -> CountryInfo?
1399
+ def read_on: () -> ChequeResponseReadOn?
1400
+ end
1401
+
1402
+ class ChequeResponseImage < VeriSecObject
1403
+ FIELDS: Hash[String, String?]
1404
+ def width: () -> Integer
1405
+ def height: () -> Integer
1406
+ def url: () -> String
1407
+ end
1408
+
1409
+ # MicrZone: One MICR line, exactly as the engine returns it, plus values derived from its text.
1410
+ class MicrZone < VeriSecObject
1411
+ FIELDS: Hash[String, String?]
1412
+ def index: () -> Integer
1413
+ def text: () -> String
1414
+ def description: () -> String
1415
+ def confidences: () -> Array[Numeric]
1416
+ def klass: () -> Integer?
1417
+ def skew: () -> Numeric
1418
+ def warpedBox: () -> Array[Numeric]?
1419
+ def font: () -> String
1420
+ def printed: () -> String
1421
+ def confidence: () -> Numeric
1422
+ def char_confidences: () -> Array[Numeric]
1423
+ def min_char_confidence: () -> Numeric?
1424
+ def box: () -> Array[Numeric]
1425
+ def segments: () -> Array[String]
1426
+ def fields: () -> Array[MicrField]?
1427
+ def field_list: () -> Array[MicrNamedValue]?
1428
+ def template: () -> String?
1429
+ def standard: () -> MicrStandardLayout?
1430
+ def routing: () -> RoutingProof?
1431
+ end
1432
+
1433
+ # MicrField: One named MICR field in the reader format: a single key (the field name, for example `Routing`) and its value.
1434
+ class MicrField < VeriSecObject
1435
+ FIELDS: Hash[String, String?]
1436
+ end
1437
+
1438
+ class MicrNamedValue < VeriSecObject
1439
+ FIELDS: Hash[String, String?]
1440
+ def name: () -> String
1441
+ def value: () -> String
1442
+ def parts: () -> Array[MicrNamedValuePart]?
1443
+ end
1444
+
1445
+ class MicrNamedValuePart < VeriSecObject
1446
+ FIELDS: Hash[String, String?]
1447
+ def name: () -> String
1448
+ def value: () -> String
1449
+ end
1450
+
1451
+ # MicrStandardLayout: An official national layout (whole-line match only).
1452
+ class MicrStandardLayout < VeriSecObject
1453
+ FIELDS: Hash[String, String?]
1454
+ def id: () -> String
1455
+ def name: () -> String
1456
+ def country: () -> String
1457
+ def fields: () -> Array[MicrNamedValue]
1458
+ def field_list: () -> Array[MicrNamedValue]?
1459
+ end
1460
+
1461
+ # RoutingProof: The ABA proof behind a US routing number.
1462
+ class RoutingProof < VeriSecObject
1463
+ FIELDS: Hash[String, String?]
1464
+ def valid: () -> bool
1465
+ def checksum_pass: () -> bool
1466
+ def check_digit: () -> Integer?
1467
+ def expected_check_digit: () -> Integer?
1468
+ def prefix_valid: () -> bool
1469
+ def institution_type: () -> String?
1470
+ def federal_reserve_district: () -> String?
1471
+ def reason: () -> String?
1472
+ end
1473
+
1474
+ # ChequeResponseQuality: Capture-quality signals.
1475
+ class ChequeResponseQuality < VeriSecObject
1476
+ FIELDS: Hash[String, String?]
1477
+ def rotation: () -> Numeric
1478
+ def skew: () -> Numeric?
1479
+ def min_char_confidence: () -> Numeric?
1480
+ end
1481
+
1482
+ # CountryInfo: The cheque's country and where it came from.
1483
+ class CountryInfo < VeriSecObject
1484
+ FIELDS: Hash[String, String?]
1485
+ def code: () -> String
1486
+ def name: () -> String
1487
+ def flag: () -> String
1488
+ def source: () -> String
1489
+ end
1490
+
1491
+ # ChequeResponseReadOn: Present when only a resized copy named fields; boxes are mapped back to the original.
1492
+ class ChequeResponseReadOn < VeriSecObject
1493
+ FIELDS: Hash[String, String?]
1494
+ def image: () -> String
1495
+ def scale: () -> Numeric
1496
+ def width: () -> Integer
1497
+ def height: () -> Integer
1498
+ end
1499
+
1500
+ # VisionResult: What is written on the cheque's face.
1501
+ class VisionResult < VeriSecObject
1502
+ FIELDS: Hash[String, String?]
1503
+ def fields: () -> Array[VisionField]?
1504
+ def amount: () -> VisionResultAmount?
1505
+ def currency: () -> VisionResultCurrency?
1506
+ def date: () -> VisionResultDate?
1507
+ def payee: () -> String?
1508
+ def drawer: () -> VisionResultDrawer?
1509
+ def bank: () -> VisionResultBank?
1510
+ def cheque_number_printed: () -> String?
1511
+ def account_number_printed: () -> String?
1512
+ def memo: () -> String?
1513
+ def pay_wording: () -> String?
1514
+ def crossing: () -> VisionResultCrossing?
1515
+ def signature: () -> VisionResultSignature?
1516
+ def cheque_type: () -> String?
1517
+ def language: () -> String?
1518
+ def region_guess: () -> String?
1519
+ end
1520
+
1521
+ # VisionField: One field the vision reader returned.
1522
+ class VisionField < VeriSecObject
1523
+ FIELDS: Hash[String, String?]
1524
+ def source_id: () -> Integer?
1525
+ def `type`: () -> String
1526
+ def value: () -> String?
1527
+ def confidence: () -> Numeric?
1528
+ def verified: () -> bool?
1529
+ def box: () -> Array[Array[Numeric]]?
1530
+ def detector_text: () -> String?
1531
+ end
1532
+
1533
+ class VisionResultAmount < VeriSecObject
1534
+ FIELDS: Hash[String, String?]
1535
+ def figures: () -> String?
1536
+ def words: () -> String?
1537
+ def numeric: () -> Numeric?
1538
+ def fraction: () -> String?
1539
+ def agreement: () -> bool?
1540
+ end
1541
+
1542
+ class VisionResultCurrency < VeriSecObject
1543
+ FIELDS: Hash[String, String?]
1544
+ def code: () -> String?
1545
+ def symbol: () -> String?
1546
+ def source: () -> String?
1547
+ end
1548
+
1549
+ class VisionResultDate < VeriSecObject
1550
+ FIELDS: Hash[String, String?]
1551
+ def raw: () -> String?
1552
+ def iso: () -> String?
1553
+ def format: () -> String?
1554
+ def ambiguous: () -> bool?
1555
+ def post_dated: () -> bool?
1556
+ end
1557
+
1558
+ # VisionResultDrawer: The account holder printed on the cheque.
1559
+ class VisionResultDrawer < VeriSecObject
1560
+ FIELDS: Hash[String, String?]
1561
+ def name: () -> String?
1562
+ def address: () -> String?
1563
+ end
1564
+
1565
+ class VisionResultBank < VeriSecObject
1566
+ FIELDS: Hash[String, String?]
1567
+ def name: () -> String?
1568
+ def country: () -> String?
1569
+ def branch: () -> String?
1570
+ def address: () -> String?
1571
+ end
1572
+
1573
+ class VisionResultCrossing < VeriSecObject
1574
+ FIELDS: Hash[String, String?]
1575
+ def present: () -> bool?
1576
+ def `type`: () -> String?
1577
+ def text: () -> String?
1578
+ end
1579
+
1580
+ class VisionResultSignature < VeriSecObject
1581
+ FIELDS: Hash[String, String?]
1582
+ def present: () -> bool?
1583
+ def count: () -> Integer?
1584
+ end
1585
+
1586
+ # BankMatch: A bank read on a document, matched in the directory.
1587
+ class BankMatch < VeriSecObject
1588
+ FIELDS: Hash[String, String?]
1589
+ def read: () -> BankMatchRead
1590
+ def resolved: () -> BankResolved?
1591
+ def match_confidence: () -> Numeric
1592
+ def name_match: () -> Numeric?
1593
+ def alternatives: () -> Array[BankResolved]
1594
+ end
1595
+
1596
+ # BankMatchRead: What the document says.
1597
+ class BankMatchRead < VeriSecObject
1598
+ FIELDS: Hash[String, String?]
1599
+ def name: () -> String?
1600
+ def country: () -> String?
1601
+ def branch: () -> String?
1602
+ def address: () -> String?
1603
+ end
1604
+
1605
+ # BankResolved: A bank from VeriSec's directory of about 75,000 banks.
1606
+ class BankResolved < VeriSecObject
1607
+ FIELDS: Hash[String, String?]
1608
+ def profile_id: () -> String
1609
+ def name: () -> String
1610
+ def country: () -> String?
1611
+ def country_code: () -> String?
1612
+ def city: () -> String?
1613
+ def address: () -> String?
1614
+ def bic: () -> String?
1615
+ def routing: () -> String?
1616
+ def parent: () -> String?
1617
+ def status: () -> String?
1618
+ def logo_url: () -> String?
1619
+ def flag_url: () -> String?
1620
+ end
1621
+
1622
+ # ResolvedCurrency: A full currency record (ISO 4217 + CLDR).
1623
+ class ResolvedCurrency < VeriSecObject
1624
+ FIELDS: Hash[String, String?]
1625
+ def code: () -> String?
1626
+ def numeric_code: () -> String?
1627
+ def name: () -> String?
1628
+ def symbol: () -> String?
1629
+ def local_symbol: () -> String?
1630
+ def minor_units: () -> String?
1631
+ def english_name_cldr: () -> String?
1632
+ def usd_per_unit: () -> (Numeric | String)?
1633
+ def units_per_usd: () -> (Numeric | String)?
1634
+ def wikidata_id: () -> String?
1635
+ end
1636
+
1637
+ # TextBoxes: Every text box on the image, for drawing only (no text).
1638
+ class TextBoxes < VeriSecObject
1639
+ FIELDS: Hash[String, String?]
1640
+ def width: () -> Integer
1641
+ def height: () -> Integer
1642
+ def boxes: () -> Array[TextBoxesBox]
1643
+ end
1644
+
1645
+ class TextBoxesBox < VeriSecObject
1646
+ FIELDS: Hash[String, String?]
1647
+ def box: () -> Array[Numeric]
1648
+ def score: () -> Numeric
1649
+ end
1650
+
1651
+ # DeepCheque: One cheque of a photo that holds several.
1652
+ class DeepCheque < VeriSecObject
1653
+ FIELDS: Hash[String, String?]
1654
+ def index: () -> Integer
1655
+ def micr: () -> DeepChequeMicr
1656
+ def vision: () -> VisionResult?
1657
+ def bank: () -> BankMatch?
1658
+ def country: () -> CountryInfo?
1659
+ def currency: () -> ResolvedCurrency?
1660
+ def reader_error: () -> String?
1661
+ end
1662
+
1663
+ class DeepChequeMicr < VeriSecObject
1664
+ FIELDS: Hash[String, String?]
1665
+ def status: () -> String
1666
+ def issue_code: () -> String?
1667
+ def issue: () -> String?
1668
+ def zones_detected: () -> Integer?
1669
+ def zones: () -> Array[MicrZone]?
1670
+ def micr: () -> MicrZone?
1671
+ def country: () -> CountryInfo?
1672
+ def quality: () -> DeepChequeMicrQuality?
1673
+ end
1674
+
1675
+ class DeepChequeMicrQuality < VeriSecObject
1676
+ FIELDS: Hash[String, String?]
1677
+ def rotation: () -> Numeric?
1678
+ def skew: () -> Numeric?
1679
+ def min_char_confidence: () -> Numeric?
1680
+ end
1681
+
1682
+ # ChequeDeepReadTiming: Where the time went, in milliseconds.
1683
+ class ChequeDeepReadTiming < VeriSecObject
1684
+ FIELDS: Hash[String, String?]
1685
+ def micr_ms: () -> Integer?
1686
+ def model_ms: () -> Integer?
1687
+ def boxes_ms: () -> Integer?
1688
+ def total_ms: () -> Integer?
1689
+ end
1690
+
1691
+ # ChequeDeepReadImageQuality: Photo quality from the check before the read.
1692
+ class ChequeDeepReadImageQuality < VeriSecObject
1693
+ FIELDS: Hash[String, String?]
1694
+ def status: () -> String
1695
+ def normalised: () -> bool?
1696
+ def ms: () -> Integer?
1697
+ end
1698
+
1699
+ # MicrLine: Just the MICR line and its named fields.
1700
+ class MicrLine < VeriSecObject
1701
+ FIELDS: Hash[String, String?]
1702
+ def object: () -> String
1703
+ def status: () -> String
1704
+ def issue_code: () -> String?
1705
+ def issue: () -> String?
1706
+ def lines_found: () -> Integer
1707
+ def processing_ms: () -> Integer
1708
+ def line: () -> MicrLineLine?
1709
+ def fields: () -> Array[MicrNamedValue]?
1710
+ def template: () -> String?
1711
+ def standard: () -> MicrStandardLayout?
1712
+ def routing: () -> RoutingProof?
1713
+ end
1714
+
1715
+ # MicrLineLine: The strongest line.
1716
+ class MicrLineLine < VeriSecObject
1717
+ FIELDS: Hash[String, String?]
1718
+ def text: () -> String
1719
+ def printed: () -> String
1720
+ def font: () -> String
1721
+ def confidence: () -> Numeric
1722
+ def min_char_confidence: () -> Numeric?
1723
+ def box: () -> Array[Numeric]
1724
+ end
1725
+
1726
+ # ChequeAmount: The amount on a cheque.
1727
+ class ChequeAmount < VeriSecObject
1728
+ FIELDS: Hash[String, String?]
1729
+ def object: () -> String
1730
+ def figures: () -> String?
1731
+ def words: () -> String?
1732
+ def numeric: () -> Numeric?
1733
+ def agreement: () -> bool?
1734
+ def currency: () -> ChequeAmountCurrency?
1735
+ def processing_ms: () -> Integer
1736
+ end
1737
+
1738
+ class ChequeAmountCurrency < VeriSecObject
1739
+ FIELDS: Hash[String, String?]
1740
+ def code: () -> String
1741
+ def name: () -> String?
1742
+ def symbol: () -> String?
1743
+ end
1744
+
1745
+ # ChequeDate: The date on a cheque.
1746
+ class ChequeDate < VeriSecObject
1747
+ FIELDS: Hash[String, String?]
1748
+ def object: () -> String
1749
+ def raw: () -> String?
1750
+ def iso: () -> String?
1751
+ def age_days: () -> Integer?
1752
+ def post_dated: () -> bool?
1753
+ def processing_ms: () -> Integer
1754
+ end
1755
+
1756
+ # ChequeParties: Who a cheque pays and who pays it.
1757
+ class ChequeParties < VeriSecObject
1758
+ FIELDS: Hash[String, String?]
1759
+ def object: () -> String
1760
+ def payee: () -> String?
1761
+ def drawer: () -> String?
1762
+ def processing_ms: () -> Integer
1763
+ end
1764
+
1765
+ # ChequeBank: The bank printed on a cheque, matched in the directory.
1766
+ class ChequeBank < VeriSecObject
1767
+ FIELDS: Hash[String, String?]
1768
+ def object: () -> String
1769
+ def read: () -> ChequeBankRead?
1770
+ def bank: () -> BankResolved?
1771
+ def match_confidence: () -> Numeric?
1772
+ def country: () -> ChequeBankCountry?
1773
+ def processing_ms: () -> Integer
1774
+ end
1775
+
1776
+ # ChequeBankRead: The bank as printed on the cheque.
1777
+ class ChequeBankRead < VeriSecObject
1778
+ FIELDS: Hash[String, String?]
1779
+ def name: () -> String?
1780
+ def branch: () -> String?
1781
+ def address: () -> String?
1782
+ def country: () -> String?
1783
+ end
1784
+
1785
+ class ChequeBankCountry < VeriSecObject
1786
+ FIELDS: Hash[String, String?]
1787
+ def code: () -> String
1788
+ def name: () -> String
1789
+ def flag: () -> String?
1790
+ def flag_url: () -> String?
1791
+ end
1792
+
1793
+ # BankLookup: A bank looked up in the directory.
1794
+ class BankLookup < VeriSecObject
1795
+ FIELDS: Hash[String, String?]
1796
+ def object: () -> String
1797
+ def query: () -> BankLookupQuery
1798
+ def bank: () -> BankResolved?
1799
+ def name_match: () -> Numeric?
1800
+ def verified: () -> bool
1801
+ def alternatives: () -> Array[BankResolved]
1802
+ end
1803
+
1804
+ # BankLookupQuery: The query as received.
1805
+ class BankLookupQuery < VeriSecObject
1806
+ FIELDS: Hash[String, String?]
1807
+ def name: () -> String?
1808
+ def country: () -> String?
1809
+ def bic: () -> String?
1810
+ end
1811
+
1812
+ # CardResponse: A card read (the Card service's wire format).
1813
+ class CardResponse < VeriSecObject
1814
+ FIELDS: Hash[String, String?]
1815
+ def id: () -> String
1816
+ def object: () -> String
1817
+ def created_at: () -> String
1818
+ def source: () -> String
1819
+ def env: () -> String
1820
+ def processing_ms: () -> Integer
1821
+ def status: () -> String
1822
+ def issue_code: () -> String?
1823
+ def issue: () -> String?
1824
+ def image: () -> CardResponseImage
1825
+ def cards_detected: () -> Integer
1826
+ def cards: () -> Array[CardRead]
1827
+ def card: () -> CardRead?
1828
+ def bin: () -> BinRecord?
1829
+ def bank: () -> BankMatch?
1830
+ end
1831
+
1832
+ # CardResponseImage: Dimensions only: card photos are never stored.
1833
+ class CardResponseImage < VeriSecObject
1834
+ FIELDS: Hash[String, String?]
1835
+ def width: () -> Integer
1836
+ def height: () -> Integer
1837
+ end
1838
+
1839
+ # CardRead: One payment card in a photo.
1840
+ class CardRead < VeriSecObject
1841
+ FIELDS: Hash[String, String?]
1842
+ def index: () -> Integer
1843
+ def description: () -> String?
1844
+ def fields: () -> Array[CardField]?
1845
+ def confidence: () -> Numeric
1846
+ def warpedBox: () -> Array[Numeric]?
1847
+ def box: () -> Array[Numeric]
1848
+ def number: () -> String?
1849
+ def first6: () -> String?
1850
+ def last4: () -> String?
1851
+ def length: () -> Integer
1852
+ def fingerprint: () -> String?
1853
+ def luhn_valid: () -> bool
1854
+ def scheme_valid: () -> bool
1855
+ def scheme_checks: () -> CardReadSchemeChecks
1856
+ def network_from_prefix: () -> String?
1857
+ def expired: () -> bool?
1858
+ def expires_in_days: () -> Integer?
1859
+ def expiry_status: () -> String
1860
+ def bin: () -> BinRecord?
1861
+ def bank: () -> BankMatch?
1862
+ def number_valid: () -> bool?
1863
+ end
1864
+
1865
+ # CardField: One field as the engine emitted it.
1866
+ class CardField < VeriSecObject
1867
+ FIELDS: Hash[String, String?]
1868
+ def name: () -> String
1869
+ def value: () -> String?
1870
+ def confidence: () -> Numeric?
1871
+ end
1872
+
1873
+ class CardReadSchemeChecks < VeriSecObject
1874
+ FIELDS: Hash[String, String?]
1875
+ def luhn: () -> bool
1876
+ def length: () -> bool
1877
+ def iin_known: () -> bool
1878
+ end
1879
+
1880
+ # BinRecord: Who issued a card.
1881
+ class BinRecord < VeriSecObject
1882
+ FIELDS: Hash[String, String?]
1883
+ def bin: () -> String
1884
+ def network: () -> String?
1885
+ def `type`: () -> String?
1886
+ def level: () -> String?
1887
+ def issuer: () -> String?
1888
+ def country: () -> String?
1889
+ def country_name: () -> String?
1890
+ def country_code3: () -> String?
1891
+ def flag: () -> String?
1892
+ def flag_url: () -> String?
1893
+ def bank: () -> BankMatch?
1894
+ def currency: () -> String?
1895
+ def currency_name: () -> String?
1896
+ def funding: () -> String?
1897
+ def is_prepaid: () -> bool?
1898
+ def is_commercial: () -> bool?
1899
+ def is_reloadable: () -> bool?
1900
+ def category: () -> String?
1901
+ def issuer_country: () -> String?
1902
+ def phone: () -> String?
1903
+ def url: () -> String?
1904
+ def source: () -> String?
1905
+ end
1906
+
1907
+ # CardNumber: The card number from a photo.
1908
+ class CardNumber < VeriSecObject
1909
+ FIELDS: Hash[String, String?]
1910
+ def object: () -> String
1911
+ def status: () -> String
1912
+ def issue_code: () -> String?
1913
+ def issue: () -> String?
1914
+ def processing_ms: () -> Integer
1915
+ def number: () -> String?
1916
+ def first6: () -> String?
1917
+ def last4: () -> String?
1918
+ def length: () -> Integer?
1919
+ def network: () -> String?
1920
+ def luhn_valid: () -> bool?
1921
+ def scheme_valid: () -> bool?
1922
+ def confidence: () -> Numeric?
1923
+ end
1924
+
1925
+ # CardExpiry: The expiry date from a card photo.
1926
+ class CardExpiry < VeriSecObject
1927
+ FIELDS: Hash[String, String?]
1928
+ def object: () -> String
1929
+ def status: () -> String
1930
+ def issue_code: () -> String?
1931
+ def issue: () -> String?
1932
+ def valid_thru: () -> String?
1933
+ def valid_from: () -> String?
1934
+ def expired: () -> bool?
1935
+ def expires_in_days: () -> Integer?
1936
+ def expiry_status: () -> String?
1937
+ def confidence: () -> Numeric?
1938
+ def processing_ms: () -> Integer
1939
+ end
1940
+
1941
+ # CardCheck: Checks on a typed card number.
1942
+ class CardCheck < VeriSecObject
1943
+ FIELDS: Hash[String, String?]
1944
+ def object: () -> String
1945
+ def first6: () -> String
1946
+ def last4: () -> String
1947
+ def length: () -> Integer
1948
+ def network: () -> String?
1949
+ def luhn_valid: () -> bool
1950
+ def length_valid: () -> bool
1951
+ def scheme_valid: () -> bool
1952
+ def expired: () -> bool?
1953
+ def expires_in_days: () -> Integer?
1954
+ def expiry_status: () -> String?
1955
+ def bin: () -> BinRecord?
1956
+ end
1957
+
1958
+ class CardFingerprint < VeriSecObject
1959
+ FIELDS: Hash[String, String?]
1960
+ def object: () -> String
1961
+ def fingerprint: () -> String
1962
+ def first6: () -> String
1963
+ def last4: () -> String
1964
+ end
1965
+ end
1966
+
1967
+ class Client
1968
+ attr_reader face: Resources::Face
1969
+ attr_reader age: Resources::Age
1970
+ attr_reader photo: Resources::Photo
1971
+ attr_reader liveness: Resources::Liveness
1972
+ attr_reader identity: Resources::Identity
1973
+ attr_reader face_login: Resources::FaceLogin
1974
+ attr_reader fraud: Resources::Fraud
1975
+ attr_reader proctor: Resources::Proctor
1976
+ attr_reader age_gate: Resources::AgeGate
1977
+ attr_reader kiosk: Resources::Kiosk
1978
+ attr_reader documents: Resources::Documents
1979
+ attr_reader proof_of_address: Resources::ProofOfAddress
1980
+ attr_reader mrz: Resources::Mrz
1981
+ attr_reader email: Resources::Email
1982
+ attr_reader osint: Resources::Osint
1983
+ attr_reader phone: Resources::Phone
1984
+ attr_reader screening: Resources::Screening
1985
+ attr_reader ip: Resources::Ip
1986
+ attr_reader contact: Resources::Contact
1987
+ attr_reader cheques: Resources::Cheques
1988
+ attr_reader banks: Resources::Banks
1989
+ attr_reader cards: Resources::Cards
1990
+ attr_reader bin: Resources::Bin
1991
+
1992
+ private
1993
+
1994
+ def build_resources: () -> void
1995
+ end
1996
+
1997
+ module Resources
1998
+ class Face < Resource
1999
+ # Face Analyze. `POST /v1/face/analyze`
2000
+ def analyze: (image: image_input, ?onlyCentralFace: bool, ?crop: Hash[String | Symbol, untyped], ?attributes: Array[String], ?qualityChecks: Array[untyped], ?tag: String, ?request_options: request_options?) -> Types::FaceAnalyze
2001
+ # Face Detect. `POST /v1/face/detect`
2002
+ def detect: (image: image_input, ?onlyCentralFace: bool, ?tag: String, ?request_options: request_options?) -> Types::FaceDetect
2003
+ # Face Count. `POST /v1/face/count`
2004
+ def count: (image: image_input, ?expected: Integer, ?tag: String, ?request_options: request_options?) -> Types::FaceCount
2005
+ # Face Attributes. `POST /v1/face/attributes`
2006
+ def attributes: (image: image_input, attributes: Array[String], ?tag: String, ?request_options: request_options?) -> Types::FaceAttributes
2007
+ # Mask & Glasses (PPE). `POST /v1/face/ppe`
2008
+ def ppe: (image: image_input, items: Array[String], ?tag: String, ?request_options: request_options?) -> Types::FacePpe
2009
+ # Emotion. `POST /v1/face/emotion`
2010
+ def emotion: (?image: image_input, ?frames: Array[image_input], ?tag: String, ?request_options: request_options?) -> Types::FaceEmotion
2011
+ # Smart Crop. `POST /v1/face/crop`
2012
+ def crop: (image: image_input, ?type: (0 | 1 | 2 | 3 | 4), ?onlyCentralFace: bool, ?tag: String, ?request_options: request_options?) -> Types::FaceCrop
2013
+ # Face Redact. `POST /v1/face/redact`
2014
+ def redact: (image: image_input, ?mode: ("blur" | "pixelate" | "box"), ?tag: String, ?request_options: request_options?) -> Types::FaceRedact
2015
+ # Face Match. `POST /v1/face/match`
2016
+ def match: (images: Array[image_input | Hash[String | Symbol, untyped]], ?crop: Hash[String | Symbol, untyped], ?limitComparePerImageTypes: Integer, ?tag: String, ?request_options: request_options?) -> Types::FaceMatch
2017
+ # Face Verify (1:1). `POST /v1/face/verify`
2018
+ def verify: (image1: image_input, image2: image_input, ?threshold: Numeric, ?livenessTransactionId: String, ?tag: String, ?request_options: request_options?) -> Types::FaceVerify
2019
+ # Similarity Score. `POST /v1/face/similarity`
2020
+ def similarity: (image1: image_input, image2: image_input, ?tag: String, ?request_options: request_options?) -> Types::FaceSimilarity
2021
+ # Face Search (1:N). `POST /v1/face/search`
2022
+ def search: (probe: image_input, gallery: Array[image_input | Hash[String | Symbol, untyped]], ?topK: Integer, ?threshold: Numeric, ?tag: String, ?request_options: request_options?) -> Types::FaceSearch
2023
+ # Duplicate Check. `POST /v1/face/dedupe`
2024
+ def dedupe: (candidate: image_input, existing: Array[image_input | Hash[String | Symbol, untyped]], ?threshold: Numeric, ?tag: String, ?request_options: request_options?) -> Types::FaceDedupe
2025
+ # Watchlist Screening. `POST /v1/face/watchlist`
2026
+ def watchlist: (probe: image_input, list: Array[image_input | Hash[String | Symbol, untyped]], ?threshold: Numeric, ?tag: String, ?request_options: request_options?) -> Types::FaceWatchlist
2027
+ # Face Cluster. `POST /v1/face/cluster`
2028
+ def cluster: (faces: Array[image_input | Hash[String | Symbol, untyped]], ?threshold: Numeric, ?tag: String, ?request_options: request_options?) -> Types::FaceCluster
2029
+ # Age Estimation. `POST /v1/face/age`
2030
+ def age: (image: image_input, ?onlyCentralFace: bool, ?crop: Hash[String | Symbol, untyped], ?tag: String, ?request_options: request_options?) -> Types::FaceAge
2031
+ # Photo Quality. `POST /v1/face/quality`
2032
+ def quality: (image: image_input, ?scenario: ("QualityICAO" | "QualityVisaSchengen" | "QualityVisaUSA" | "QualityFull"), ?onlyCentralFace: bool, ?output: Hash[String | Symbol, untyped], ?customChecks: untyped, ?tag: String, ?request_options: request_options?) -> Types::FaceQuality
2033
+ end
2034
+
2035
+ class Age < Resource
2036
+ # Age Check. `POST /v1/age/verify`
2037
+ def verify: (image: image_input, ?minAge: Integer, ?policy: ("lowerBound" | "midpoint"), ?tag: String, ?request_options: request_options?) -> Types::AgeVerify
2038
+ # Age Check + Liveness. `POST /v1/age/verify-live`
2039
+ def verify_live: (image: image_input, ?minAge: Integer, ?tag: String, ?request_options: request_options?) -> Types::AgeVerifyLive
2040
+ end
2041
+
2042
+ class Photo < Resource
2043
+ # Photo Compliance. `POST /v1/photo/compliance`
2044
+ def compliance: (image: image_input, ?standard: ("ICAO" | "VisaSchengen" | "VisaUSA" | "Full"), ?tag: String, ?request_options: request_options?) -> Types::PhotoCompliance
2045
+ # Photo Policy. `POST /v1/photo/policy`
2046
+ def policy: (image: image_input, policy: Array[untyped], ?tag: String, ?request_options: request_options?) -> Types::PhotoPolicy
2047
+ # Quality Gate. `POST /v1/photo/gate`
2048
+ def gate: (image: image_input, require: Array[String], ?tag: String, ?request_options: request_options?) -> Types::PhotoGate
2049
+ # Photo Auto-fix. `POST /v1/photo/autofix`
2050
+ def autofix: (image: image_input, ?aspect: ("3:4" | "4:5" | "2:3" | "1:1"), ?backgroundColor: Array[Integer], ?tag: String, ?request_options: request_options?) -> Types::PhotoAutofix
2051
+ # Best Frame. `POST /v1/photo/best-frame`
2052
+ def best_frame: (frames: Array[image_input], ?standard: ("ICAO" | "VisaSchengen" | "VisaUSA" | "Full"), ?tag: String, ?request_options: request_options?) -> Types::PhotoBestFrame
2053
+ end
2054
+
2055
+ class Liveness < Resource
2056
+ # Liveness. `POST /v1/liveness`
2057
+ def check: (image: image_input, ?tag: String, ?request_options: request_options?) -> Types::LivenessCheck
2058
+ # Anti-spoof Reason. `POST /v1/liveness/antispoof`
2059
+ def antispoof: (image: image_input, ?tag: String, ?request_options: request_options?) -> Types::LivenessAntispoof
2060
+ # Liveness Gate. `POST /v1/liveness/gate`
2061
+ def gate: (image: image_input, ?strict: bool, ?tag: String, ?request_options: request_options?) -> Types::LivenessGate
2062
+ end
2063
+
2064
+ class Identity < Resource
2065
+ # Identity Verification. `POST /v1/identity/verify`
2066
+ def verify: (selfie: image_input, reference: image_input, ?minQuality: Array[String], ?threshold: Numeric, ?tag: String, ?request_options: request_options?) -> Types::IdentityVerify
2067
+ end
2068
+
2069
+ class FaceLogin < Resource
2070
+ # Face Login. `POST /v1/auth/login`
2071
+ def authenticate: (selfie: image_input, gallery: Array[image_input | Hash[String | Symbol, untyped]], ?threshold: Numeric, ?tag: String, ?request_options: request_options?) -> Types::FaceLoginAuthenticate
2072
+ end
2073
+
2074
+ class Fraud < Resource
2075
+ # Sign-up Fraud Check. `POST /v1/fraud/signup-check`
2076
+ def signup_check: (selfie: image_input, existing: Array[image_input | Hash[String | Symbol, untyped]], ?tag: String, ?request_options: request_options?) -> Types::FraudSignupCheck
2077
+ end
2078
+
2079
+ class Proctor < Resource
2080
+ # Proctoring Check. `POST /v1/proctor/check`
2081
+ def check: (frame: image_input, ?tag: String, ?request_options: request_options?) -> Types::ProctorCheck
2082
+ end
2083
+
2084
+ class AgeGate < Resource
2085
+ # Age-gated Checkout. `POST /v1/age-gate/checkout`
2086
+ def checkout: (selfie: image_input, ?minAge: Integer, ?tag: String, ?request_options: request_options?) -> Types::AgeGateCheckout
2087
+ end
2088
+
2089
+ class Kiosk < Resource
2090
+ # Photo Kiosk. `POST /v1/kiosk/photo`
2091
+ def photo: (image: image_input, ?standard: ("ICAO" | "VisaSchengen" | "VisaUSA" | "Full"), ?aspect: ("3:4" | "4:5" | "2:3" | "1:1"), ?backgroundColor: Array[Integer], ?tag: String, ?request_options: request_options?) -> Types::KioskPhoto
2092
+ end
2093
+
2094
+ class Documents < Resource
2095
+ # Document Read. `POST /v1/idv/read`
2096
+ def read: (image_front: image_input, ?image_back: image_input, ?scenario: ("FullProcess" | "FullAuth" | "Barcode" | "Mrz"), ?doc_hint: Hash[String | Symbol, untyped], ?request_options: request_options?) -> Types::DocumentRead
2097
+ # Document Classify. `POST /v1/idv/classify`
2098
+ def classify: (image: image_input, ?request_options: request_options?) -> Types::DocumentClassify
2099
+ # Document MRZ. `POST /v1/idv/mrz`
2100
+ def mrz: (image: image_input, ?request_options: request_options?) -> Types::DocumentMrz
2101
+ # Document Portrait. `POST /v1/idv/portrait`
2102
+ def portrait: (image: image_input, ?request_options: request_options?) -> Types::DocumentPortrait
2103
+ # Document Authenticity. `POST /v1/idv/authenticity`
2104
+ def authenticity: (image_front: image_input, ?image_back: image_input, ?request_options: request_options?) -> Types::DocumentAuthenticity
2105
+ # Document Fields. `POST /v1/idv/fields`
2106
+ def fields: (image: image_input, ?request_options: request_options?) -> Types::DocumentFields
2107
+ end
2108
+
2109
+ class ProofOfAddress < Resource
2110
+ # Proof of Address. `POST /v1/poa/analyze`
2111
+ def analyze: (document_token: String, ?filename: String, ?expected: Hash[String | Symbol, untyped], ?request_options: request_options?) -> Types::ProofOfAddressAnalyze
2112
+ end
2113
+
2114
+ class Mrz < Resource
2115
+ # MRZ Read. `POST /v1/mrz/read`
2116
+ def read: (image: image_input, ?request_options: request_options?) -> Types::MrzRead
2117
+ # MRZ Recognize. `POST /v1/mrz/recognize`
2118
+ def recognize: (image: image_input, ?request_options: request_options?) -> Types::MrzRecognize
2119
+ # MRZ Parse. `POST /v1/mrz/parse`
2120
+ def parse: (lines: Array[String], ?request_options: request_options?) -> Types::MrzParse
2121
+ end
2122
+
2123
+ class Email < Resource
2124
+ # Email Risk. `POST /v1/email/verify`
2125
+ def verify: (email: String, ?request_options: request_options?) -> Types::EmailVerify
2126
+ # Email Accounts. `POST /v1/email/footprint`
2127
+ def footprint: (email: String, ?request_options: request_options?) -> Types::EmailFootprint
2128
+ end
2129
+
2130
+ class Osint < Resource
2131
+ # Username Search. `POST /v1/osint/username`
2132
+ def username: (username: String, ?top: Integer, ?request_options: request_options?) -> Types::OsintUsername
2133
+ # Adverse Media. `POST /v1/osint/web`
2134
+ def web: (query: String, ?mode: ("aml" | "all"), ?request_options: request_options?) -> Types::OsintWeb
2135
+ end
2136
+
2137
+ class Phone < Resource
2138
+ attr_reader otp: PhoneOtp
2139
+
2140
+ def initialize: (Transport transport) -> void
2141
+
2142
+ # Phone Intelligence. `POST /v1/phone/lookup`
2143
+ def lookup: (phone: String, ?first_name: String, ?last_name: String, ?date_of_birth: String, ?country: String, ?request_options: request_options?) -> Types::PhoneLookup
2144
+ end
2145
+
2146
+ class PhoneOtp < Resource
2147
+ # Send Phone Code. `POST /v1/phone/otp/send`
2148
+ def send: (phone: String, ?request_options: request_options?) -> Types::PhoneOtpSend
2149
+ # Check Phone Code. `POST /v1/phone/otp/check`
2150
+ def check: (phone: String, code: String, ?request_options: request_options?) -> Types::PhoneOtpCheck
2151
+ end
2152
+
2153
+ class Screening < Resource
2154
+ # IP Risk. `POST /v1/screen/ip`
2155
+ def ip: (ip: String, ?request_options: request_options?) -> Types::ScreeningIp
2156
+ # Sanctions & PEP Screening. `POST /v1/screen/sanctions`
2157
+ def sanctions: (name: String, ?schema: ("Person" | "Company" | "Organization" | "LegalEntity"), ?birth_date: String, ?countries: Array[String], ?id_numbers: Array[String], ?limit: Integer, ?request_options: request_options?) -> Types::ScreeningSanctions
2158
+ # Wallet Screening. `POST /v1/screen/crypto`
2159
+ def crypto: (addresses: Array[String], ?request_options: request_options?) -> Types::ScreeningCrypto
2160
+ end
2161
+
2162
+ class Ip < Resource
2163
+ # IP Anonymity. `POST /v1/ip/analyze`
2164
+ def analyze: (ip: String, ?request_options: request_options?) -> Types::IpAnalyze
2165
+ end
2166
+
2167
+ class Contact < Resource
2168
+ # Contact Dossier. `POST /v1/verify/contact`
2169
+ def dossier: (?email: String, ?phone: String, ?name: String, ?dob: String, ?country: String, ?ip: String, ?wallet: String, ?include: Array[String], ?request_options: request_options?) -> Types::ContactDossier
2170
+ end
2171
+
2172
+ class Cheques < Resource
2173
+ # Read a whole cheque. `POST /v2/cheques/read`
2174
+ def read: (image: file_input, ?format: ("auto" | "e13b" | "cmc7"), ?request_options: request_options?) -> Types::ChequeDeepRead
2175
+ # Read a cheque's MICR line. `POST /v2/cheques/micr`
2176
+ def micr: (image: file_input, ?format: ("auto" | "e13b" | "cmc7"), ?request_options: request_options?) -> Types::ChequeResponse
2177
+ # Read just the MICR line. `POST /v2/cheques/micr-line`
2178
+ def micr_line: (image: file_input, ?format: ("auto" | "e13b" | "cmc7"), ?request_options: request_options?) -> Types::MicrLine
2179
+ # Read a cheque's amount. `POST /v2/cheques/amount`
2180
+ def amount: (image: file_input, ?request_options: request_options?) -> Types::ChequeAmount
2181
+ # Read a cheque's date. `POST /v2/cheques/date`
2182
+ def date: (image: file_input, ?request_options: request_options?) -> Types::ChequeDate
2183
+ # Read a cheque's payee and drawer. `POST /v2/cheques/parties`
2184
+ def parties: (image: file_input, ?request_options: request_options?) -> Types::ChequeParties
2185
+ # Read a cheque's bank. `POST /v2/cheques/bank`
2186
+ def bank: (image: file_input, ?request_options: request_options?) -> Types::ChequeBank
2187
+ end
2188
+
2189
+ class Banks < Resource
2190
+ # Look up a bank. `GET /v2/banks`
2191
+ def lookup: (?name: String, ?country: String, ?bic: String, ?request_options: request_options?) -> Types::BankLookup
2192
+ end
2193
+
2194
+ class Cards < Resource
2195
+ # Read a payment card. `POST /v2/cards/read`
2196
+ def read: (image: file_input, ?request_options: request_options?) -> Types::CardResponse
2197
+ # Read a card number. `POST /v2/cards/number`
2198
+ def number: (image: file_input, ?request_options: request_options?) -> Types::CardNumber
2199
+ # Read a card's expiry date. `POST /v2/cards/expiry`
2200
+ def expiry: (image: file_input, ?request_options: request_options?) -> Types::CardExpiry
2201
+ # Check a card number. `POST /v2/cards/check`
2202
+ def check: (number: String, ?expiry: String, ?request_options: request_options?) -> Types::CardCheck
2203
+ # Fingerprint a card number. `POST /v2/cards/fingerprint`
2204
+ def fingerprint: (number: String, ?request_options: request_options?) -> Types::CardFingerprint
2205
+ end
2206
+
2207
+ class Bin < Resource
2208
+ # Look up a BIN. `GET /v2/bin/{digits}`
2209
+ def lookup: (String | Integer digits, ?request_options: request_options?) -> Types::BinRecord
2210
+ end
2211
+ end
2212
+ end