Skip to content

Commit df86120

Browse files
ArtsiomTsybulkoArtsiomTsybulko
authored
Merge pull request #302 from regulaforensics/develop
Develop -> Stable
2 parents fbd53b0 + b785c1e commit df86120

10 files changed

Lines changed: 286 additions & 4 deletions

‎.github/workflows/verify-clients.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ jobs:
2424

2525
- name: Verify update Python client
2626
working-directory: python-client
27+
env:
28+
API_BASE_PATH: ${{ github.base_ref == 'develop' && 'https://nightly-api.regulaforensics.com' || 'https://rc-api.regulaforensics.com' }}
2729
run: |
2830
./update-models.sh strict
2931
./setup.sh
@@ -44,6 +46,8 @@ jobs:
4446

4547
- name: Verify update CSharp client
4648
working-directory: csharp-client
49+
env:
50+
API_BASE_PATH: ${{ github.base_ref == 'develop' && 'https://nightly-api.regulaforensics.com' || 'https://rc-api.regulaforensics.com' }}
4751
run: |
4852
./update-models.sh strict
4953
./setup.sh
@@ -91,6 +95,8 @@ jobs:
9195

9296
- name: Verify update Java client
9397
working-directory: java-client
98+
env:
99+
API_BASE_PATH: ${{ github.base_ref == 'develop' && 'https://nightly-api.regulaforensics.com' || 'https://rc-api.regulaforensics.com' }}
94100
run: |
95101
./update-models.sh strict
96102
./gradlew clean :example:run

‎common.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -518,3 +518,35 @@ components:
518518
format: float
519519
description: "The maximum allowable part of the area occupied by the glare. The same: 0.06 = 6%"
520520
example: 0.0
521+
522+
MDLDeviceEngagement:
523+
title: "MDLDeviceEngagement"
524+
type: integer
525+
enum:
526+
- 0
527+
- 1
528+
x-enum-varnames:
529+
- "QR"
530+
- "NFC"
531+
532+
MDLDeviceRetrieval:
533+
title: "MDLDeviceRetrieval"
534+
type: integer
535+
enum:
536+
- 1
537+
- 2
538+
- 3
539+
x-enum-varnames:
540+
- "NFC"
541+
- "BLE"
542+
- "WIFI_AWARE"
543+
544+
MDLServerRetrieval:
545+
title: "MDLServerRetrieval"
546+
type: integer
547+
enum:
548+
- 0
549+
- 1
550+
x-enum-varnames:
551+
- "WEB_API"
552+
- "OIDC"

‎e-text-field-type.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -654,6 +654,9 @@ components:
654654
- 697
655655
- 698
656656
- 699
657+
- 701
658+
- 702
659+
- 703
657660
x-enum-descriptions:
658661
- "Document class code"
659662
- "Issuing state code"
@@ -1304,6 +1307,9 @@ components:
13041307
- "Nationality code (Alpha-2)"
13051308
- "First issue date check digit"
13061309
- "First issue date checksum"
1310+
- "Commercial indicator"
1311+
- "Non domiciled indicator"
1312+
- "Jurisdiction specific data"
13071313
x-enum-varnames:
13081314
- "DOCUMENT_CLASS_CODE"
13091315
- "ISSUING_STATE_CODE"
@@ -1954,3 +1960,6 @@ components:
19541960
- "FT_NATIONALITY_CODE_ALPHA2"
19551961
- "FT_FIRST_ISSUE_DATE_CHECK_DIGIT"
19561962
- "FT_FIRST_ISSUE_DATE_CHECKSUM"
1963+
- "FT_COMMERCIAL_INDICATOR"
1964+
- "FT_NON_DOMICILED_INDICATOR"
1965+
- "FT_JURISDICTION_SPECIFIC_DATA"

‎index.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,9 @@ components:
8787
$ref: "./e-rfid-pkd-resourcetype.yml#/components/schemas/RFIDPKDResourceType"
8888
ParsingErrorCodes:
8989
$ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes"
90+
MDLDeviceEngagement:
91+
$ref: "./common.yml#/components/schemas/MDLDeviceEngagement"
92+
MDLDeviceRetrieval:
93+
$ref: "./common.yml#/components/schemas/MDLDeviceRetrieval"
94+
MDLServerRetrieval:
95+
$ref: "./common.yml#/components/schemas/MDLServerRetrieval"

‎p-process.yml‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,18 @@ components:
246246
type: boolean
247247
# default false
248248
fieldTypesFilter:
249-
description: "List of text field types to extract. If empty, all text fields from template will be extracted.
250-
Narrowing the list can shorten processing time. Empty by default."
249+
description: "If a document contains Visual zone, you can set the list of field types to extract.
250+
In this case, other fields are skipped during the processing, i.e. document recognition becomes faster.
251+
This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesFilter is empty, all fields are extracted. Empty by default.
252+
If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority."
253+
type: array
254+
items:
255+
$ref: "./e-text-field-type.yml#/components/schemas/TextFieldType"
256+
fieldTypesIgnoreFilter:
257+
description: "If a document contains a Visual zone, you can specify a list of field types that should be excluded from extraction.
258+
All field types listed in this array are skipped during processing, while the remaining fields are recognized.
259+
This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesIgnoreFilter is empty, all fields are extracted. Empty by default.
260+
If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority."
251261
type: array
252262
items:
253263
$ref: "./e-text-field-type.yml#/components/schemas/TextFieldType"

‎rt-rfid-binary-data.yml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -596,8 +596,6 @@ components:
596596
description: "Structure is used to store information about the numeric field (4 bytes) that is a part of one of the informational
597597
data groups."
598598
type: object
599-
required:
600-
- Data
601599
properties:
602600
Type:
603601
type: integer

‎rt-status.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ components:
2020
- rfid
2121
- stopList
2222
- detailsOptical
23+
- age
24+
- detailsAge
25+
- mDL
2326
properties:
2427
overallStatus: # Overall checks status. Rootx status
2528
$ref: "./common.yml#/components/schemas/CheckResult"
@@ -35,6 +38,12 @@ components:
3538
$ref: "#/components/schemas/detailsRFID"
3639
detailsOptical:
3740
$ref: "#/components/schemas/detailsOptical"
41+
age:
42+
$ref: "./common.yml#/components/schemas/CheckResult"
43+
detailsAge:
44+
$ref: "#/components/schemas/DetailsAge"
45+
mDL:
46+
$ref: "./common.yml#/components/schemas/CheckResult"
3847

3948
detailsOptical:
4049
title: "detailsOptical"
@@ -97,3 +106,27 @@ components:
97106
$ref: "./common.yml#/components/schemas/CheckResult"
98107
TA: # Terminal Authentication status
99108
$ref: "./common.yml#/components/schemas/CheckResult"
109+
110+
DetailsAge:
111+
title: "DetailsAge"
112+
type: object
113+
required:
114+
- threshold
115+
- overThreshold
116+
- over18
117+
- over21
118+
- over25
119+
- over65
120+
properties:
121+
threshold:
122+
type: integer
123+
overThreshold:
124+
$ref: "./common.yml#/components/schemas/CheckResult"
125+
over18:
126+
$ref: "./common.yml#/components/schemas/CheckResult"
127+
over21:
128+
$ref: "./common.yml#/components/schemas/CheckResult"
129+
over25:
130+
$ref: "./common.yml#/components/schemas/CheckResult"
131+
over65:
132+
$ref: "./common.yml#/components/schemas/CheckResult"

‎rt-vds-data.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
openapi: 3.0.4
2+
components:
3+
schemas:
4+
VDSDataItem:
5+
title: "VDSDataItem"
6+
type: object
7+
required:
8+
- dftVDS
9+
properties:
10+
dftVDS:
11+
$ref: "#/components/schemas/VDSData"
12+
13+
VDSData:
14+
title: "VDSData"
15+
type: object
16+
properties:
17+
Certificate:
18+
type: string
19+
CertificateChain:
20+
type: array
21+
items:
22+
$ref: "./rt-rfid-binary-data.yml#/components/schemas/RfidCertificateEx"
23+
DocFeatures:
24+
type: array
25+
items:
26+
$ref: "#/components/schemas/DocFeature"
27+
DocIssueDate:
28+
type: string
29+
DocType:
30+
type: integer
31+
FeatureRef:
32+
type: integer
33+
IssuingCountry:
34+
type: string
35+
Notifications:
36+
type: array
37+
items:
38+
type: integer
39+
Signature:
40+
$ref: "./rt-rfid-binary-data.yml#/components/schemas/TrfFtBytes"
41+
SignatureDate:
42+
type: string
43+
Signer:
44+
type: string
45+
Type:
46+
type: integer
47+
Version:
48+
type: integer
49+
50+
DocFeature:
51+
title: "DocFeature"
52+
type: object
53+
required:
54+
- Type
55+
- Data
56+
properties:
57+
Type:
58+
type: number
59+
Data:
60+
$ref: "./rt-rfid-binary-data.yml#/components/schemas/TrfFtBytes"

‎rt-vds-nc-data.yml‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
openapi: 3.0.4
2+
components:
3+
schemas:
4+
VDSNCDataItem:
5+
title: "VDSNCDataItem"
6+
type: object
7+
required:
8+
- dftVDS_NC
9+
properties:
10+
dftVDS_NC:
11+
$ref: "#/components/schemas/VDSNCData"
12+
13+
VDSNCData:
14+
title: "VDSNCData"
15+
type: object
16+
properties:
17+
Certificate:
18+
$ref: "./rt-rfid-binary-data.yml#/components/schemas/TrfFtBytes"
19+
CertificateChain:
20+
type: array
21+
items:
22+
$ref: "./rt-rfid-binary-data.yml#/components/schemas/RfidCertificateEx"
23+
IssuingCountry:
24+
type: string
25+
Message:
26+
$ref: "#/components/schemas/Message"
27+
Notifications:
28+
type: array
29+
items:
30+
type: integer
31+
Signature:
32+
$ref: "./rt-rfid-binary-data.yml#/components/schemas/TrfFtBytes"
33+
SignatureAlg:
34+
type: string
35+
Type:
36+
type: string
37+
Version:
38+
type: integer
39+
40+
Message:
41+
title: "Message"
42+
type: object
43+
properties:
44+
pid:
45+
$ref: "#/components/schemas/PID"
46+
uvci:
47+
type: string
48+
ve:
49+
type: array
50+
items:
51+
$ref: "#/components/schemas/VEItem"
52+
53+
PID:
54+
title: "PID"
55+
type: object
56+
properties:
57+
dob:
58+
type: string
59+
i:
60+
type: string
61+
n:
62+
type: string
63+
sex:
64+
type: string
65+
66+
VEItem:
67+
title: "VEItem"
68+
type: object
69+
properties:
70+
des:
71+
type: string
72+
dis:
73+
type: string
74+
nam:
75+
type: string
76+
vd:
77+
type: array
78+
items:
79+
$ref: "#/components/schemas/VDItem"
80+
81+
VDItem:
82+
title: "VDItem"
83+
type: object
84+
properties:
85+
adm:
86+
type: string
87+
ctr:
88+
type: string
89+
dvc:
90+
type: string
91+
lot:
92+
type: string
93+
seq:
94+
type: integer

0 commit comments

Comments
 (0)