From af7084841f9a2e2f0fa5812dbfb3cc3dedd4da21 Mon Sep 17 00:00:00 2001 From: Artsiom Tsybulko Date: Fri, 21 Aug 2026 17:44:00 +0300 Subject: [PATCH 1/5] 64344 - add enum descriptions --- authenticity/e-check-diagnose.yml | 133 ++++++++++++++++++++++++++++++ common.yml | 10 +++ e-rfid-data-file-type.yml | 102 +++++++++++++++++++++++ p-process.yml | 4 + 4 files changed, 249 insertions(+) diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index 7f77c9b..1535533 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -271,3 +271,136 @@ components: - "PROPERTY_NO_SIGNATURE" - "PROPERTY_TEXT_AS_SIGNATURE" - "PROPERTY_FINGERPRINT_AS_SIGNATURE" + x-enum-descriptions: + - "Check was not performed" + - "Check was OK" + - "Invalid input data" + - "Internal error in module" + - "Exception caught" + - "can't make reliable decision" + - "Image in necessary light was not found" + - "Necessary side of photo was not found" + - "Invalid checksum" + - "Syntactical error" + - "Logical error" + - "Comparison was incorrect" + - "Logical error, e.g. the current date is less than issue date" + - "Wrong field format" + - "Element of the luminescense in the UV does not meet the standard" + - "The presence of excess luminescence in UV" + - "Pattern does not match the standard" + - "Low contrast of object in transmitted IR light" + - "Background of page is too light or has invalid color" + - "Background lightness of two pages is different" + - "Text has incorrect color of luminescence in UV light" + - "Invalid luminescence in photo area" + - "Object is too shifted from standard coordinates" + - "Contact chip type mismatch" + - "No protective fibers were found in UV" + - "Error finding fibers, too many objects" + - "Speck or exposure in UV image" + - "Resolution too low for fibers search" + - "Erroneous visibility of the element in IR" + - "Element is absent in IR" + - "Element should be in color" + - "Element should be in grayscale" + - "Photo white IR do not match" + - "Glow paper in MRZ" + - "Luminescence characters in MRZ" + - "Glow in the field of photo paper" + - "Glow of the whole paper form" + - "Glow of the document in UV" + - "Element of blank has luminescence" + - "Violation of the retro-reflective protection" + - "Invalid params for IPI check" + - "Encrypted IPI not found, information not decoded" + - "Decoded data don't match to other data sources" + - "IR image too bright" + - "Glares in photo area" + - "Photo replaced" + - "Field pos corrector landmarks check error" + - "Field pos corrector face presence check error" + - "Field pos corrector face absence check error" + - "Field pos corrector incorrect head position" + - "Field pos corrector age check error" + - "Field pos corrector sex check error" + - "OVI object is not visible in IR" + - "Insufficient area of the object OVI" + - "OVI color of an object does not change" + - "Impossible to determine the color of the AXIAL image" + - "Impossible to determine the color of the WHITE image" + - "Wide color spread" + - "Not enough color information" + - "Hologram element absent" + - "There are no side or top images. Check cancelled" + - "Hologram element present" + - "Hologram frames is absent" + - "Hologram holo field is absent" + - "Pattern is interrupted" + - "Some of the patterns are shifted relative to each other" + - "Some parts of the pattern have different color" + - "Pattern visible in the infrared" + - "Edge of the photo does not intersect with the pattern. Check cancelled" + - "Size of the photo does not correspond to requirements" + - "Some parts of the pattern have invalid color" + - "Some patterns are relatively shifted" + - "Not found Pattern. Check cancelled" + - "Different lines thickness" + - "Photo shape is not rectangular" + - "Photo corners don't satisfy the requirements" + - "For internal use" + - "Text color should be blue" + - "Text color should be green" + - "Text color should be red" + - "Text should be black" + - "Security text is absent" + - "Barcode read with errors" + - "Barcode data format error" + - "Barcode size parameters error" + - "This document should contain more barcodes" + - "Glares in barcode area" + - "No certificate for digital signature check" + - "The portraits do not match" + - "The service does not respond" + - "Service error" + - "Not enough images" + - "There is no camera image" + - "There is no license for the service" + - "No portraits detected" + - "Unsuitable light conditions" + - "No difference in visible and UV mobile images. Possible UV torch malfunction" + - "Fingerprints comparison mismatch" + - "Face isn’t detected" + - "Face comparison failed" + - "Glare in center absent" + - "Hologram element shape error" + - "Algorithm steps error" + - "Hologram areas not loaded" + - "Hologram check finished by time out" + - "Holo photo document outside frame" + - "Liveness depth check failed" + - "Wrong mrz dpi" + - "Wrong background" + - "MRZ quality wrong MRZ width" + - "MRZ quality wrong MRZ height" + - "MRZ quality wrong line position" + - "MRZ quality wrong font type" + - "OCR quality text position" + - "OCR quality invalid font" + - "OCR quality invalid background" + - "Invalid LASINK lines frequency" + - "Verification failed" + - "Black and white copy detected" + - "Traces of an electronic device were found in the image" + - "Invalid barcode background" + - "Virtual camera was detected" + - "Base32 barcode error" + - "Data decompression error" + - "Message zone is empty" + - "Signature must be present" + - "Signature must not be present" + - "Certificate reference must not be present" + - "Incorrect object color" + - "No signature" + - "Text as signature" + - "Fingerprint as signature" diff --git a/common.yml b/common.yml index be2b661..3a8eb08 100644 --- a/common.yml +++ b/common.yml @@ -544,6 +544,9 @@ components: x-enum-varnames: - "QR" - "NFC" + x-enum-descriptions: + - "Device Engagement using the QR code" + - "Device Engagement using the NFC module" MDLDeviceRetrieval: title: "MDLDeviceRetrieval" @@ -556,6 +559,10 @@ components: - "NFC" - "BLE" - "WIFI_AWARE" + x-enum-descriptions: + - "Device Retrieval using the NFC module" + - "Device Retrieval using the Bluetooth module" + - "Device Retrieval using the Wi-Fi Aware module" MDLServerRetrieval: title: "MDLServerRetrieval" @@ -566,3 +573,6 @@ components: x-enum-varnames: - "WEB_API" - "OIDC" + x-enum-descriptions: + - "Retrieval using the Web API" + - "Retrieval using OpenID Connect" diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml index 074a85b..e9a72a9 100644 --- a/e-rfid-data-file-type.yml +++ b/e-rfid-data-file-type.yml @@ -210,3 +210,105 @@ components: - "VDS_NC" - "DS" - "USER_DEFINED" + x-enum-descriptions: + - "Not specified" + - "Passport DG1" + - "Passport DG2" + - "Passport DG3" + - "Passport DG4" + - "Passport DG5" + - "Passport DG6" + - "Passport DG7" + - "Passport DG8" + - "Passport DG9" + - "Passport DG10" + - "Passport DG11" + - "Passport DG12" + - "Passport DG13" + - "Passport DG14" + - "Passport DG15" + - "Passport DG16" + - "Passport DG17" + - "Passport DG18" + - "Passport DG19" + - "Passport DG20" + - "Passport SOD" + - "Passport CVCA" + - "Passport COM" + - "DTC DG17" + - "DTC DG18" + - "DTC DG22" + - "DTC DG23" + - "DTC DG24" + - "ID DG1" + - "ID DG2" + - "ID DG3" + - "ID DG4" + - "ID DG5" + - "ID DG6" + - "ID DG7" + - "ID DG8" + - "ID DG9" + - "ID DG10" + - "ID DG11" + - "ID DG12" + - "ID DG13" + - "ID DG14" + - "ID DG15" + - "ID DG16" + - "ID DG17" + - "ID DG18" + - "ID DG19" + - "ID DG20" + - "ID DG21" + - "ID DG22" + - "DL COM" + - "DL DG1" + - "DL DG2" + - "DL DG3" + - "DL DG4" + - "DL DG5" + - "DL DG6" + - "DL DG7" + - "DL DG8" + - "DL DG9" + - "DL DG10" + - "DL DG11" + - "DL DG12" + - "DL DG13" + - "DL DG14" + - "DL SOD" + - "DL CE" + - "DL CVCA" + - "PACE card access" + - "PACE card security" + - "PACE chip security" + - "MIFARE data" + - "MIFARE validity" + - "Authenticity V2" + - "ATR" + - "DIR" + - "eSign PK" + - "eSign signed data" + - "Certificate" + - "Master list" + - "Defect list" + - "Deviation list" + - "Black list" + - "App directory" + - "Session" + - "Log data" + - "Chip properties" + - "DTC info" + - "Post CA response" + - "Post CA public key" + - "Post CA info" + - "Post CA d params" + - "Post CA check PK" + - "Post CA check SK" + - "SAM data" + - "SAM data max" + - "VDS" + - "VDS-NC" + - "DS" + - "User defined" diff --git a/p-process.yml b/p-process.yml index fb03f39..f0d5099 100644 --- a/p-process.yml +++ b/p-process.yml @@ -547,6 +547,10 @@ components: - "eMDM_Default" - "eMDM_ResizeBinarizeWindow" - "eMDM_BlurBeforeBinarization" + x-enum-descriptions: + - "Default detection mode" + - "Apply window resizing for image binarization" + - "Apply blur image processing before binarization" AuthParams: title: "AuthParams" From 31b82559860636dd44cb78317e85a61cb9c2d65f Mon Sep 17 00:00:00 2001 From: Uladzislau Yakimchyk <31860804+vyakimchik@users.noreply.github.com> Date: Fri, 21 Aug 2026 17:54:41 +0300 Subject: [PATCH 2/5] Update e-check-diagnose.yml --- authenticity/e-check-diagnose.yml | 32 +++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index 1535533..6512972 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -277,7 +277,7 @@ components: - "Invalid input data" - "Internal error in module" - "Exception caught" - - "can't make reliable decision" + - "Can't make reliable decision" - "Image in necessary light was not found" - "Necessary side of photo was not found" - "Invalid checksum" @@ -318,12 +318,12 @@ components: - "IR image too bright" - "Glares in photo area" - "Photo replaced" - - "Field pos corrector landmarks check error" - - "Field pos corrector face presence check error" - - "Field pos corrector face absence check error" - - "Field pos corrector incorrect head position" - - "Field pos corrector age check error" - - "Field pos corrector sex check error" + - "Landmarks check error" + - "Face presence check error" + - "Face absence check error" + - "Incorrect head position" + - "Age check error" + - "Sex check error" - "OVI object is not visible in IR" - "Insufficient area of the object OVI" - "OVI color of an object does not change" @@ -344,7 +344,7 @@ components: - "Size of the photo does not correspond to requirements" - "Some parts of the pattern have invalid color" - "Some patterns are relatively shifted" - - "Not found Pattern. Check cancelled" + - "Not found pattern, check cancelled" - "Different lines thickness" - "Photo shape is not rectangular" - "Photo corners don't satisfy the requirements" @@ -368,7 +368,7 @@ components: - "There is no license for the service" - "No portraits detected" - "Unsuitable light conditions" - - "No difference in visible and UV mobile images. Possible UV torch malfunction" + - "No difference in visible and UV mobile images, possible UV torch malfunction" - "Fingerprints comparison mismatch" - "Face isn’t detected" - "Face comparison failed" @@ -381,13 +381,13 @@ components: - "Liveness depth check failed" - "Wrong mrz dpi" - "Wrong background" - - "MRZ quality wrong MRZ width" - - "MRZ quality wrong MRZ height" - - "MRZ quality wrong line position" - - "MRZ quality wrong font type" - - "OCR quality text position" - - "OCR quality invalid font" - - "OCR quality invalid background" + - "MRZ quality: wrong MRZ width" + - "MRZ quality: wrong MRZ height" + - "MRZ quality: wrong line position" + - "MRZ quality: wrong font type" + - "OCR quality: text position" + - "OCR quality: invalid font" + - "OCR quality: invalid background" - "Invalid LASINK lines frequency" - "Verification failed" - "Black and white copy detected" From 0c3cbe574ca7660c9c3a6301ba2d6e809c51728b Mon Sep 17 00:00:00 2001 From: Uladzislau Yakimchyk <31860804+vyakimchik@users.noreply.github.com> Date: Fri, 21 Aug 2026 17:55:15 +0300 Subject: [PATCH 3/5] Apply suggestion from @vyakimchik --- e-rfid-data-file-type.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml index e9a72a9..8ac8720 100644 --- a/e-rfid-data-file-type.yml +++ b/e-rfid-data-file-type.yml @@ -303,7 +303,7 @@ components: - "Post CA response" - "Post CA public key" - "Post CA info" - - "Post CA d params" + - "Post CA params" - "Post CA check PK" - "Post CA check SK" - "SAM data" From 9c8a5ce13491345a3134f47a33f0722660985e4a Mon Sep 17 00:00:00 2001 From: Uladzislau Yakimchyk <31860804+vyakimchik@users.noreply.github.com> Date: Fri, 21 Aug 2026 18:05:06 +0300 Subject: [PATCH 4/5] Modify description for AuthenticityResultType Updated description to clarify authenticity control procedures. --- authenticity/e-result-type.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml index dbab1ab..8b1bdc3 100644 --- a/authenticity/e-result-type.yml +++ b/authenticity/e-result-type.yml @@ -5,7 +5,7 @@ components: title: "AuthenticityResultType" type: integer format: int64 - description: "Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/." + description: "Enumeration contains identifiers determining the possibility of performing different authenticity control procedures using the images for definite lighting schemes." enum: - 1 - 2 From 50d77c8a5bf624ccc144b16e8ee8382eb9b23238 Mon Sep 17 00:00:00 2001 From: Vladislav Yakimchik Date: Fri, 21 Aug 2026 18:06:18 +0300 Subject: [PATCH 5/5] updated --- authenticity/e-check-diagnose.yml | 2 +- e-security-feature-type.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index 6512972..6d4be88 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -4,7 +4,7 @@ components: CheckDiagnose: title: "CheckDiagnose" type: integer - description: "Enumeration contains identifiers which determinate the single document element authenticity check outcome reason: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/check-diagnose/" + description: "Enumeration contains identifiers which determine the result of the text field comparison from the different sources." enum: - 0 - 1 diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index 975c079..9877faa 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -4,7 +4,7 @@ components: SecurityFeatureType: title: "SecurityFeatureType" type: integer - description: "Enumeration contains identifiers determining type of features for a document authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/security-feature-type/" + description: "Enumeration contains identifiers determining type of features for a document authenticity checks." enum: - 0 - 1