-
Notifications
You must be signed in to change notification settings - Fork 0
/
single.yml
7512 lines (7420 loc) · 218 KB
/
single.yml
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
openapi: 3.0.3
info:
version: 7.2.0
title: Regula Document Reader Web API
x-logo:
url: https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg
href: https://regulaforensics.com
description: >
Documents recognition as easy as reading two bytes.
# Clients:
*
[JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client)
client for the browser and node.js based on axios
* [Java](https://github.com/regulaforensics/DocumentReader-web-java-client)
client compatible with jvm and android
*
[Python](https://github.com/regulaforensics/DocumentReader-web-python-client)
3.5+ client
* [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client)
client for .NET & .NET Core
servers:
- url: https://api.regulaforensics.com/
description: Latest stable Regula Document Reader demo endpoint
- url: https://nightly-api.regulaforensics.com/
description: Nightly Regula document reader demo endpoint
- url: http://localhost:8080/
description: Local on-premise installation
paths:
/api/process:
parameters:
- $ref: '#/components/parameters/x-request'
post:
summary: Process list of documents images and return extracted data
operationId: api-process
tags:
- process
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessRequest'
required: true
responses:
'200':
description: Document reading result
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessResponse'
'400':
description: Bad request. Check your input data.
'403':
description: >-
Bad license. Either server or request does not contain valid
license.
x-codeSamples:
- lang: JavaScript
source: >
import {DocumentReaderApi, FieldType, GraphicFieldType} from
'@regulaforensics/document-reader-webclient/esm'
const {DOCUMENT_NUMBER, SURNAME_AND_GIVEN_NAMES, DATE_OF_BIRTH} =
FieldType;
const {PORTRAIT, SIGNATURE} = GraphicFieldType;
const imageAsBase64String = getDocImageAsBase64String()
const api = new DocumentReaderApi({basePath:
"http://localhost:8080"});
const result = await api.process(imageAsBase64String)
// text fields
const docNumber = result.getTextField(DOCUMENT_NUMBER)
const fullName = result.getTextField(SURNAME_AND_GIVEN_NAMES)
const dateOfBirth = result.getTextField(DATE_OF_BIRTH)
// graphics fields
const portraitAsBase64 = result.getGraphicsField(PORTRAIT)
const signatureAsBase64 = result.getGraphicsField(SIGNATURE)
- lang: Java
source: >
byte[] imageBytes = readFile("australia_passport.jpg");
var image = new ProcessRequestImage(imageBytes, Light.WHITE);
var requestParams = new RecognitionParams()
.withScenario(Scenario.FULL_PROCESS)
.withResultTypeOutput(Result.STATUS, Result.TEXT, Result.IMAGES);
RecognitionRequest request = new RecognitionRequest(requestParams,
List.of(image));
var api = new DocumentReaderApi();
RecognitionResponse response = api.process(request);
var status = response.status();
var docOverallStatus = status.getComplete() == CheckResult.OK ?
"valid" : "not valid";
var docOpticalTextStatus = status.getDetailsOptical().getText();
var docNumberField = response.text().getField(DOCUMENT_NUMBER);
var docNumberMrz = docNumberField.getValue(Source.MRZ);
var docNumberMrzValidity =
docNumberField.sourceValidity(Source.MRZ);
var docNumberMrzVisualMatching =
docNumberField.crossSourceComparison(Source.MRZ, Source.VISUAL);
- lang: Python
source: >
from regula.documentreader.webclient import *
with open("australia_passport.jpg", "rb") as f:
input_image = f.read()
with DocumentReaderApi(host='http://localhost:8080') as api:
params = ProcessParams(
scenario=Scenario.FULL_PROCESS,
result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
)
request = RecognitionRequest(process_params=params, images=[input_image])
response = api.process(request)
# status examples
response_status = response.status
doc_overall_status = "valid" if response_status.overall_status ==
CheckResult.OK else "not valid"
# text fields example
doc_number_field =
response.text.get_field(TextFieldType.DOCUMENT_NUMBER)
doc_number_mrz = doc_number_field.get_value()
doc_number_visual = doc_number_field.get_value(Source.VISUAL)
doc_number_visual_validity =
doc_number_field.source_validity(Source.VISUAL)
doc_number_mrz_validity =
doc_number_field.source_validity(Source.MRZ)
doc_number_mrz_visual_matching =
doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)
# images fields example
normalized_input_image = response.images.document_image()
portrait_field =
response.images.get_field(GraphicFieldType.PORTRAIT)
portrait_from_visual = portrait_field.get_value(Source.VISUAL)
portrait_from_rfid = portrait_field.get_value(Source.RFID,
original=True)
- lang: C#
source: >
var imageBytes = File.ReadAllBytes("australia_passport.jpg");
var image = new ProcessRequestImage(new ImageData(imageBytes),
Light.WHITE);
var requestParams = new RecognitionParams()
.WithScenario(Scenario.FULL_PROCESS)
.WithResultTypeOutput(new List<int> { Result.STATUS, Result.TEXT,
Result.IMAGES, Result.DOCUMENT_TYPE });
var request = new RecognitionRequest(requestParams, image);
var api = licenseFromEnv != null
? new DocumentReaderApi(apiBaseUrl).WithLicense(licenseFromEnv)
: new DocumentReaderApi(apiBaseUrl).WithLicense(licenseFromFile);
var response = api.Process(request);
// status examples
var status = response.Status();
string docOverallStatus = status.OverallStatus == CheckResult.OK ?
"valid" : "not valid";
string docOpticalTextStatus = status.DetailsOptical.Text ==
CheckResult.OK ? "valid" : "not valid";
// text fields examples
var docNumberField =
response.Text().GetField(TextFieldType.DOCUMENT_NUMBER);
string docNumberVisual = docNumberField.GetValue(Source.VISUAL);
string docNumberMrz = docNumberField.GetValue(Source.MRZ);
int docNumberVisualValidity =
docNumberField.SourceValidity(Source.VISUAL);
int docNumberMrzValidity =
docNumberField.SourceValidity(Source.MRZ);
int docNumberMrzVisualMatching =
docNumberField.CrossSourceComparison(Source.MRZ, Source.VISUAL);
// images fields examples
var documentImage =
response.Images().GetField(GraphicFieldType.DOCUMENT_FRONT).GetValue();
var portraitField =
response.Images().GetField(GraphicFieldType.PORTRAIT);
var portraitFromVisual = portraitField.GetValue(Source.VISUAL);
/api/v2/transaction/{transaction_id}/process:
post:
parameters:
- in: path
name: transaction_id
schema:
type: integer
format: uuid
required: true
description: Transaction id
summary: Reprocess
tags:
- transaction
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionProcessRequest'
required: true
responses:
'200':
description: Transaction Process result
content:
application/json:
schema:
type: object
properties:
OutData:
$ref: '#/components/schemas/OutData'
InData:
$ref: '#/components/schemas/InData'
tag:
type: string
transactionId:
type: string
format: uuid
'400':
description: Bad request. Check your input data.
'403':
description: >-
Bad license. Either server or request does not contain valid
license.
/api/v2/transaction/{transaction_id}:
get:
parameters:
- in: path
name: transaction_id
schema:
type: integer
format: uuid
required: true
description: Transaction id
summary: Get Reprocess transaction data
tags:
- transaction
responses:
'200':
description: Reprocess transaction data
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionProcessGetResponse'
'400':
description: Bad request. Check your input data.
'403':
description: >-
Bad license. Either server or request does not contain valid
license.
/api/v2/transaction/{transaction_id}/results:
get:
parameters:
- in: path
name: transaction_id
schema:
type: integer
format: uuid
required: true
description: Transaction id
- in: query
name: withImages
schema:
type: boolean
enum:
- true
- false
description: With base64 images or url
summary: Get Reprocess transaction result
tags:
- transaction
responses:
'200':
description: Transaction data
content:
application/json:
schema:
type: object
properties:
ChipPage:
$ref: '#/components/schemas/RfidLocation'
ProcessingFinished:
$ref: '#/components/schemas/ProcessingStatus'
ContainerList:
$ref: '#/components/schemas/ContainerList'
TransactionInfo:
$ref: '#/components/schemas/TransactionInfo'
log:
description: Base64 encoded transaction processing log
type: string
passBackObject:
type: object
description: >-
Free-form object provided in request. See passBackObject
property of ProcessRequest.
additionalProperties: true
morePagesAvailable:
type: integer
elapsedTime:
type: integer
description: Time the document processing has taken, ms.
CoreLibResultCode:
type: integer
'400':
description: Bad request. Check your input data.
'403':
description: >-
Bad license. Either server or request does not contain valid
license.
/api/v2/transaction/{transaction_id}/file:
get:
parameters:
- in: path
name: transaction_id
schema:
type: integer
format: uuid
required: true
description: Transaction id
- in: query
name: name
schema:
type: string
required: true
description: File name
summary: Get Reprocess transaction file
tags:
- transaction
responses:
'200':
description: Binary file
content:
application/octet-stream:
schema:
type: string
format: binary
'404':
description: File not found
/api/v2/tag/{tag_id}:
delete:
parameters:
- in: path
name: tag_id
schema:
type: integer
format: uuid
required: true
description: Tag id
summary: Delete Reprocess transactions by tag
tags:
- transaction
responses:
'204':
description: Transactions deleted
content:
application/json:
schema: {}
'400':
description: Bad request. Check your input data.
'403':
description: >-
Bad license. Either server or request does not contain valid
license.
/api/ping:
parameters:
- $ref: '#/components/parameters/x-request'
get:
summary: Server health check
operationId: ping
responses:
'200':
description: Device info
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceInfo'
tags:
- name: process
description: Everything about perfoming request and parsing response
- name: status_model
x-displayName: Status Model
description: |
<SchemaDefinition schemaRef="#/components/schemas/Status" />
- name: text_model
x-displayName: Text Model
description: |
<SchemaDefinition schemaRef="#/components/schemas/Text" />
- name: images_model
x-displayName: Images Model
description: |
**Images model:**
<SchemaDefinition schemaRef="#/components/schemas/Images" />
**Document image model:**
<SchemaDefinition schemaRef="#/components/schemas/DocumentImage" />
- name: document_model
x-displayName: Document Model
description: >
**Choosen Document model:**
<SchemaDefinition schemaRef="#/components/schemas/ChosenDocumentType" />
**Candidates model:**
<SchemaDefinition schemaRef="#/components/schemas/DocumentTypesCandidates"
/>
- name: authenticity_model
x-displayName: Authenticity Model
description: >
<SchemaDefinition schemaRef="#/components/schemas/AuthenticityCheckResult"
/>
x-tagGroups:
- name: Requests
tags:
- process
- transaction
- name: Models
tags:
- status_model
- text_model
- images_model
- document_model
- authenticity_model
components:
schemas:
Status:
type: object
required:
- overallStatus
- optical
- detailsOptical
properties:
overallStatus:
description: Overall checks status. Root status.
$ref: '#/components/schemas/CheckResult'
optical:
description: Overall optical checks combined status
$ref: '#/components/schemas/CheckResult'
portrait:
description: Portrait comparison status
$ref: '#/components/schemas/CheckResult'
rfid:
description: Overall RFID checks combined status
$ref: '#/components/schemas/CheckResult'
stopList:
description: Stop list check status
$ref: '#/components/schemas/CheckResult'
detailsRFID:
description: Details on performed RFID checks
$ref: '#/components/schemas/detailsRFID'
detailsOptical:
description: Details on performed optical checks
$ref: '#/components/schemas/detailsOptical'
Text:
type: object
description: >-
Contains all document text fields data with validity and cross-source
compare checks
required:
- status
- validityStatus
- comparisonStatus
- fieldList
- availableSourceList
properties:
status:
description: Overall status of all checks from all text fields
$ref: '#/components/schemas/CheckResult'
validityStatus:
description: Overall status of validity from all text fields from all sources
$ref: '#/components/schemas/CheckResult'
comparisonStatus:
description: >-
Overall status of data comparison from different sources for each
text field
$ref: '#/components/schemas/CheckResult'
fieldList:
type: array
items:
$ref: '#/components/schemas/TextField'
availableSourceList:
type: array
items:
$ref: '#/components/schemas/TextAvailableSource'
Images:
type: object
required:
- availableSourceList
- fieldList
properties:
availableSourceList:
type: array
items:
$ref: '#/components/schemas/ImagesAvailableSource'
fieldList:
type: array
items:
$ref: '#/components/schemas/ImagesField'
DocumentImage:
$ref: '#/components/schemas/ImageData'
TransactionImage:
$ref: '#/components/schemas/ImageTransactionData'
DocumentTypesCandidates:
$ref: '#/components/schemas/DocumentTypesCandidatesList'
ChosenDocumentType:
$ref: '#/components/schemas/OneCandidate'
AuthenticityCheckResult:
type: object
required:
- Type
- Result
- List
properties:
Type:
$ref: '#/components/schemas/AuthenticityResultType'
Result:
$ref: '#/components/schemas/CheckResult'
List:
type: array
items:
anyOf:
- $ref: '#/components/schemas/SecurityFeatureResult'
- $ref: '#/components/schemas/IdentResult'
- $ref: '#/components/schemas/FiberResult'
- $ref: '#/components/schemas/OCRSecurityTextResult'
- $ref: '#/components/schemas/PhotoIdentResult'
AuthenticityResultType:
type: integer
description: >-
Enumeration describes available authenticity checks:
https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/.
enum:
- 1
- 2
- 4
- 8
- 16
- 32
- 64
- 128
- 512
- 1024
- 4096
- 8192
- 32768
- 65536
- 131072
- 262144
- 524288
- 1048576
- 2097152
- 4194304
- 8388608
x-enum-descriptions:
- Document luminescence check in UV light
- B900 ink MRZ contrast check in IR light
- Image patterns presence/absence check (position, shape, color)
- Confirm laminate integrity check in axial light
- Protection fibers presence check (color, density) in UV light
- Document elements visibility check in IR light
- >-
OCR for the text field in UV light comparison with other text sources
check
- Invisible Personal Information (IPI) visualization
- Owner's photo embedding check (is photo printed or sticked)
- OVI check
- Hologram presence check
- Owner's photo area advanced check (photo shape, size, position, etc.)
- Portrait comparison check (document printed vs chip vs live)
- >-
Barcode format check (code metadata, data format, contents format,
etc.)
- Kinegram check
- LetterScreen check
- Hologram detection and validation check
- Fingerprint comparison check
- Document liveness check
- Extended OCR Check
- Extended MRZ check
x-enum-varnames:
- UV_LUMINESCENCE
- IR_B900
- IMAGE_PATTERN
- AXIAL_PROTECTION
- UV_FIBERS
- IR_VISIBILITY
- OCR_SECURITY_TEXT
- IPI
- PHOTO_EMBED_TYPE
- OVI
- HOLOGRAMS
- PHOTO_AREA
- PORTRAIT_COMPARISON
- BARCODE_FORMAT_CHECK
- KINEGRAM
- LETTER_SCREEN
- HOLOGRAM_DETECTION
- FINGERPRINT_COMPARISON
- LIVENESS
- EXTENDED_OCR_CHECK
- EXTENDED_MRZ_CHECK
FaceApi:
type: object
properties:
url:
type: string
example: https://faceapi.regulaforensics.com
description: The URL of the Regula Face Web service to be used.
mode:
type: string
example: match
description: 'The processing mode: "match" or "match+search".'
search:
type: object
description: >-
A search filter that can be applied if the "match+search" mode is
enabled. May include limit, threshold, group_ids. If the group_ids
are specified, the search is performed only in these groups. Find
more information in the <a
href="https://dev.regulaforensics.com/FaceSDK-web-openapi/#tag/search/operation/search"
target="_blank">OpenAPI documentation</a>.
properties:
limit:
type: integer
description: The maximum number of results to be returned.
threshold:
type: number
description: The similarity threshold.
group_ids:
type: array
items:
type: integer
description: ' The groups where to conduct the search.'
threshold:
type: integer
example: 75
description: >-
The similarity threshold, 0-100. Above 75 means that the faces'
similarity is verified, below 75 is not.
serviceTimeout:
type: integer
example: 3000
description: The Regula Face Web service requests timeout, ms.
proxy:
type: string
example: http://localhost:8080
description: >-
Proxy to use, should be set according to the <a
href="https://curl.se/libcurl/c/CURLOPT_PROXY.html"
target="_blank">cURL standard</a>.
proxy_userpwd:
type: string
example: user:pass
description: >-
Username and password to use for proxy authentication, should be set
according to the <a
href="https://curl.se/libcurl/c/CURLOPT_PROXYUSERPWD.html"
target="_blank">cURL standard</a>.
proxy_type:
type: integer
example: 0
description: >-
Proxy protocol type, should be set according to the <a
href="https://curl.se/libcurl/c/CURLOPT_PROXYTYPE.html"
target="_blank">cURL standard</a>.
Scenario:
type: string
description: Document processing scenario
enum:
- Mrz
- Barcode
- Locate
- Ocr
- DocType
- MrzOrBarcode
- MrzOrLocate
- MrzAndLocate
- BarcodeAndLocate
- MrzOrOcr
- MrzOrBarcodeOrOcr
- LocateVisual_And_MrzOrOcr
- FullProcess
- FullAuth
- RusStamp
- OcrFree
- CreditCard
- Capture
x-enum-varnames:
- MRZ
- BARCODE
- LOCATE
- OCR
- DOCTYPE
- MRZ_OR_BARCODE
- MRZ_OR_LOCATE
- MRZ_AND_LOCATE
- BARCODE_AND_LOCATE
- MRZ_OR_OCR
- MRZ_OR_BARCODE_OR_OCR
- LOCATE_VISUAL_AND_MRZ_OR_OCR
- FULL_PROCESS
- FULL_AUTH
- RUS_STAMP
- OCR_FREE
- CREDIT_CARD
- CAPTURE
x-enum-descriptions:
- Processing scenario for obtaining MRZ data
- Processing scenario for obtaining barcode data
- Processing scenario for detecting document boundaries
- Processing scenario for obtaining visual zone OCR results
- Processing scenario for document type recognition
- Processing scenario for obtaining MRZ and/or barcode data
- >-
Processing scenario for detecting document boundaries and/or obtaining
MRZ data
- >-
Processing scenario for detecting document boundaries and obtaining
MRZ data
- >-
Processing scenario for detecting the document boundaries and
obtaining barcode data
- Processing scenario for obtaining MRZ data or visual zone OCR results
- >-
Processing scenario for obtaining MRZ or barcode or visual zone OCR
results
- >-
Processing scenario for detecting document boundaries and obtaining
MRZ data or visual zone OCR results
- Processing scenario for obtaining all document data
- >-
Processing scenario for obtaining all document data and document
authentication
- Processing scenario for obtaining data from registration stamps
- Processing scenario for obtaining OCR results of any image
- Processing scenario for obtaining bank card data
- Scenario for obtaining an original image without any processing
Result:
type: integer
enum:
- 1
- 3
- 5
- 6
- 8
- 9
- 15
- 17
- 18
- 19
- 20
- 30
- 33
- 34
- 36
- 37
- 39
- 49
- 50
- 85
- 101
- 102
- 103
- 104
- 105
x-enum-descriptions:
- >-
Contains cropped and rotated with perspective compensation image of
document. Single input image can contain multiple document side/pages,
which will be returned as separated results. Most of coordinates in
other types defined on that image
- Contains MRZ OCR results
- Contains raw information about barcodes on the input image
- Contains cropped graphic fields from Visual zone
- >-
Contains list of document type candidates with their probabilities and
descriptions
- Contains description of determined document type, if any
- >-
Contains lexical data analysis results that allow you to compare MRZ
OCR results, Visual zone OCR results, barcodes and RFID chip data for
an additional assessment of the authenticity of the document (this is
an old format, better use TEXT type)
- Contains Visual zone OCR results
- Contains barcode parsing result with text fields
- Contains barcode parsing result with graphic fields
- Contains result of document authenticity checks
- Contains image quality check results
- Contains check statuses with details, grouped by source
- Contains result of portraits comparison
- >-
Contains document textual fields from all sources (mrz, rfid, visual,
barcode) with validity and cross-source compare checks
- Contains images from all document sources (mrz, rfid, visual, barcode)
- Contains result of fingerprints comparison
- Contains encrypted ResultContainerList
- Contains license
- >-
Contains information about document position on the input image, its
center, angle, etc
- Contains RFID raw data
- Contains RFID text results
- Contains RFID graphic results
- Contains RFID binary data
- Contains RFID original graphics data
x-enum-varnames:
- DOCUMENT_IMAGE
- MRZ_TEXT
- BARCODES
- VISUAL_GRAPHICS
- DOCUMENT_TYPE_CANDIDATES
- DOCUMENT_TYPE
- LEXICAL_ANALYSIS
- VISUAL_TEXT
- BARCODE_TEXT
- BARCODE_GRAPHICS
- AUTHENTICITY
- IMAGE_QUALITY
- STATUS
- PORTRAIT_COMPARISON
- TEXT
- IMAGES
- FINGERPRINT_COMPARISON
- ENCRYPTED_RCL
- LICENSE
- DOCUMENT_POSITION
- RFID_RAW_DATA
- RFID_TEXT
- RFID_GRAPHICS
- RFID_BINARY_DATA
- RFID_ORIGINAL_GRAPHICS
TextFieldType:
type: integer
enum:
- 0
- 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
- 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