Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/verify-clients.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ jobs:

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

- name: Verify update CSharp client
working-directory: csharp-client
env:
API_BASE_PATH: ${{ github.base_ref == 'develop' && 'https://nightly-api.regulaforensics.com' || 'https://rc-api.regulaforensics.com' }}
run: |
./update-models.sh strict
./setup.sh
Expand Down Expand Up @@ -91,6 +95,8 @@ jobs:

- name: Verify update Java client
working-directory: java-client
env:
API_BASE_PATH: ${{ github.base_ref == 'develop' && 'https://nightly-api.regulaforensics.com' || 'https://rc-api.regulaforensics.com' }}
run: |
./update-models.sh strict
./gradlew clean :example:run
32 changes: 32 additions & 0 deletions common.yml
Original file line number Diff line number Diff line change
Expand Up @@ -518,3 +518,35 @@ components:
format: float
description: "The maximum allowable part of the area occupied by the glare. The same: 0.06 = 6%"
example: 0.0

MDLDeviceEngagement:
title: "MDLDeviceEngagement"
type: integer
enum:
- 0
- 1
x-enum-varnames:
- "QR"
- "NFC"

MDLDeviceRetrieval:
title: "MDLDeviceRetrieval"
type: integer
enum:
- 1
- 2
- 3
x-enum-varnames:
- "NFC"
- "BLE"
- "WIFI_AVARE"

MDLServerRetrieval:
title: "MDLServerRetrieval"
type: integer
enum:
- 0
- 1
x-enum-varnames:
- "WEB_API"
- "OIDC"
9 changes: 9 additions & 0 deletions e-text-field-type.yml
Original file line number Diff line number Diff line change
Expand Up @@ -654,6 +654,9 @@ components:
- 697
- 698
- 699
- 701
- 702
- 703
x-enum-descriptions:
- "Document class code"
- "Issuing state code"
Expand Down Expand Up @@ -1304,6 +1307,9 @@ components:
- "Nationality code (Alpha-2)"
- "First issue date check digit"
- "First issue date checksum"
- "Commercial indicator"
- "Non domiciled indicator"
- "Jurisdiction specific data"
x-enum-varnames:
- "DOCUMENT_CLASS_CODE"
- "ISSUING_STATE_CODE"
Expand Down Expand Up @@ -1954,3 +1960,6 @@ components:
- "FT_NATIONALITY_CODE_ALPHA2"
- "FT_FIRST_ISSUE_DATE_CHECK_DIGIT"
- "FT_FIRST_ISSUE_DATE_CHECKSUM"
- "FT_COMMERCIAL_INDICATOR"
- "FT_NON_DOMICILED_INDICATOR"
- "FT_JURISDICTION_SPECIFIC_DATA"
6 changes: 6 additions & 0 deletions index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,9 @@ components:
$ref: "./e-rfid-pkd-resourcetype.yml#/components/schemas/RFIDPKDResourceType"
ParsingErrorCodes:
$ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes"
MDLDeviceEngagement:
$ref: "./common.yml#/components/schemas/MDLDeviceEngagement"
MDLDeviceRetrieval:
$ref: "./common.yml#/components/schemas/MDLDeviceRetrieval"
MDLServerRetrieval:
$ref: "./common.yml#/components/schemas/MDLServerRetrieval"
33 changes: 33 additions & 0 deletions rt-status.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ components:
- rfid
- stopList
- detailsOptical
- age
- detailsAge
- mDL
properties:
overallStatus: # Overall checks status. Rootx status
$ref: "./common.yml#/components/schemas/CheckResult"
Expand All @@ -35,6 +38,12 @@ components:
$ref: "#/components/schemas/detailsRFID"
detailsOptical:
$ref: "#/components/schemas/detailsOptical"
age:
$ref: "./common.yml#/components/schemas/CheckResult"
detailsAge:
$ref: "#/components/schemas/DetailsAge"
mDL:
$ref: "./common.yml#/components/schemas/CheckResult"

detailsOptical:
title: "detailsOptical"
Expand Down Expand Up @@ -97,3 +106,27 @@ components:
$ref: "./common.yml#/components/schemas/CheckResult"
TA: # Terminal Authentication status
$ref: "./common.yml#/components/schemas/CheckResult"

DetailsAge:
title: "DetailsAge"
type: object
required:
- threshold
- overThreshold
- over18
- over21
- over25
- over65
properties:
threshold:
type: integer
overThreshold:
$ref: "./common.yml#/components/schemas/CheckResult"
over18:
$ref: "./common.yml#/components/schemas/CheckResult"
over21:
$ref: "./common.yml#/components/schemas/CheckResult"
over25:
$ref: "./common.yml#/components/schemas/CheckResult"
over65:
$ref: "./common.yml#/components/schemas/CheckResult"
18 changes: 18 additions & 0 deletions rt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ components:
- 104
- 105
- 109
- 120
- 121
- 122
- 123
- 124
- 125
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"
Expand Down Expand Up @@ -84,6 +90,12 @@ components:
- "Contains RFID binary data"
- "Contains RFID original graphics data"
- "Digital Travel Credential data"
- "Contains mDL device raw response"
- "Contains mDL device parsed response"
- "Contains mDL server raw response"
- "Contains mDL server parsed response"
- "Contains result of VDS NC"
- "Contains result of VDS"
x-enum-varnames:
- "DOCUMENT_IMAGE"
- "MRZ_TEXT"
Expand Down Expand Up @@ -121,6 +133,12 @@ components:
- "RFID_BINARY_DATA"
- "RFID_ORIGINAL_GRAPHICS"
- "DTC_VC"
- "MDL_DEVICE_RAW_RESPONSE"
- "MDL_DEVICE_PARSED_RESPONSE"
- "MDL_SERVER_RAW_RESPONSE"
- "MDL_SERVER_PARSED_RESPONSE"
- "VDS_NC"
- "VDS"

ResultItem:
title: "ResultItem"
Expand Down