From 02f63d5c0162ce1d814bd360008a19f782ec444b Mon Sep 17 00:00:00 2001 From: Artsiom Tsybulko Date: Tue, 7 Oct 2025 14:26:52 +0300 Subject: [PATCH 1/7] 43539 - update CheckDiagnose, SecurityFeatureType enums --- authenticity/e-check-diagnose.yml | 4 ++++ e-security-feature-type.yml | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index f0acaf8f..03f10969 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -56,6 +56,8 @@ components: - 84 - 85 - 86 + - 87 + - 88 - 90 - 91 - 92 @@ -183,6 +185,8 @@ components: - "FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR" - "FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR" - "FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION" + - "FIELD_POS_CORRECTOR_AGE_COMPARISON_ERROR" + - "FIELD_POS_CORRECTOR_SEX_COMPARISON_ERROR" - "OVI_IR_INVISIBLE" - "OVI_INSUFFICIENT_AREA" - "OVI_COLOR_INVARIABLE" diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index 6867496c..4d35477c 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -61,6 +61,8 @@ components: - 53 - 54 - 55 + - 56 + - 57 x-enum-descriptions: - "Blank element" - "Personalization element" @@ -117,6 +119,8 @@ components: - "Black and white copy check" - "Liveness dynaprint" - "Liveness geometry check" + - "Age comparison visual vs. face" + - "Sex comparison visual vs. face" x-enum-varnames: - "BLANK" - "FILL" @@ -173,3 +177,5 @@ components: - "LIVENESS_BLACK_AND_WHITE_COPY_CHECK" - "LIVENESS_DYNAPRINT" - "LIVENESS_GEOMETRY_CHECK" + - "AGE_COMPARISON_VISUAL_VS_FACE" + - "SEX_COMPARISON_VISUAL_VS_FACE" From 98807921b4304dc10570674d973b2ab4da180838 Mon Sep 17 00:00:00 2001 From: Artsiom Tsybulko Date: Mon, 13 Oct 2025 12:02:39 +0300 Subject: [PATCH 2/7] 43539 - update CheckDiagnose, SecurityFeatureType enums --- authenticity/e-check-diagnose.yml | 4 ++-- e-security-feature-type.yml | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index 03f10969..5c454446 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -185,8 +185,8 @@ components: - "FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR" - "FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR" - "FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION" - - "FIELD_POS_CORRECTOR_AGE_COMPARISON_ERROR" - - "FIELD_POS_CORRECTOR_SEX_COMPARISON_ERROR" + - "FIELD_POS_CORRECTOR_AGE_CHECK_ERROR" + - "FIELD_POS_CORRECTOR_SEX_CHECK_ERROR" - "OVI_IR_INVISIBLE" - "OVI_INSUFFICIENT_AREA" - "OVI_COLOR_INVARIABLE" diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index 4d35477c..123fe690 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -119,8 +119,8 @@ components: - "Black and white copy check" - "Liveness dynaprint" - "Liveness geometry check" - - "Age comparison visual vs. face" - - "Sex comparison visual vs. face" + - "Age check" + - "Sex check" x-enum-varnames: - "BLANK" - "FILL" @@ -177,5 +177,5 @@ components: - "LIVENESS_BLACK_AND_WHITE_COPY_CHECK" - "LIVENESS_DYNAPRINT" - "LIVENESS_GEOMETRY_CHECK" - - "AGE_COMPARISON_VISUAL_VS_FACE" - - "SEX_COMPARISON_VISUAL_VS_FACE" + - "AGE_CHECK" + - "SEX_CHECK" From 66d1067ce28da47aead10f400949fac715395f93 Mon Sep 17 00:00:00 2001 From: Artsiom Tsybulko <60066359+ArtsiomTsybulko@users.noreply.github.com> Date: Fri, 17 Oct 2025 16:28:53 +0300 Subject: [PATCH 3/7] 43792 - add glaresCheckParams (#288) --- common.yml | 15 +++++++++++++++ p-process.yml | 2 ++ 2 files changed, 17 insertions(+) diff --git a/common.yml b/common.yml index d2db2685..9e834cbc 100644 --- a/common.yml +++ b/common.yml @@ -503,3 +503,18 @@ components: type: integer ResultStatus: type: integer + + GlaresCheckParams: + title: "GlaresCheckParams" + type: object + properties: + imgMarginPart: + type: number + format: float + description: "Margin from the edges of the image. 0.35 = 35%" + example: 0.35 + maxGlaringPart: + type: number + format: float + description: "The maximum allowable part of the area occupied by the glare. The same: 0.06 = 6%" + example: 0.0 diff --git a/p-process.yml b/p-process.yml index a98d9f38..acd4fe8b 100644 --- a/p-process.yml +++ b/p-process.yml @@ -717,6 +717,8 @@ components: type: array items: $ref: "./rt-image-quality.yml#/components/schemas/InputImageQualityChecks" + glaresCheckParams: + $ref: "./common.yml#/components/schemas/GlaresCheckParams" ProcessRequestImage: title: "ProcessRequestImage" From a914639eb5c45fac6d4f0faca239a01638477103 Mon Sep 17 00:00:00 2001 From: Artsiom Tsybulko Date: Mon, 27 Oct 2025 13:03:19 +0300 Subject: [PATCH 4/7] 45719 - add /api/doclist --- index.yml | 20 ++---------- p-doclist.yml | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 91 insertions(+), 18 deletions(-) create mode 100644 p-doclist.yml diff --git a/index.yml b/index.yml index c759abcd..dfa30e70 100644 --- a/index.yml +++ b/index.yml @@ -43,24 +43,15 @@ paths: $ref: "./p-healthcheck.yml#/paths/~1healthz" /api/readyz: $ref: "./p-healthcheck.yml#/paths/~1readyz" + /api/doclist: + $ref: "./p-doclist.yml#/paths/~1doclist" tags: - name: process description: Everything about performing request and parsing response - - name: status_model - x-displayName: Status Model - description: | - - - name: text_model - x-displayName: Text Model - description: | - - name: images_model x-displayName: Images Model description: | - **Images model:** - - **Document image model:** - name: document_model x-displayName: Document Model @@ -69,10 +60,6 @@ tags: **Candidates model:** - - name: authenticity_model - x-displayName: Authenticity Model - description: | - x-tagGroups: - name: Requests @@ -82,11 +69,8 @@ x-tagGroups: - healthcheck - name: Models tags: - - status_model - - text_model - images_model - document_model - - authenticity_model components: schemas: diff --git a/p-doclist.yml b/p-doclist.yml new file mode 100644 index 00000000..dd008797 --- /dev/null +++ b/p-doclist.yml @@ -0,0 +1,89 @@ +openapi: 3.0.4 +paths: + /doclist: + get: + summary: "Returns the list of documents stored in the database that the Web Service API is running with." + operationId: doclist + responses: + 200: + description: "The list of documents stored in the database." + content: + application/json: + schema: + $ref: "#/components/schemas/DatabaseDocumentList" + +components: + schemas: + DatabaseDocumentList: + title: "DatabaseDocumentList" + type: object + required: + - items + properties: + items: + description: "The list of documents stored in the database." + type: array + items: + $ref: "#/components/schemas/DatabaseDocument" + + DatabaseDocument: + title: "DatabaseDocument" + type: object + required: + - barcode_fields + - country + - createad + - doc_type + - document + - graphic_fields + - id + - mrz + - rfid_chip + - text_fields + - updated + properties: + barcode_fields: + description: "Whether the document has a barcode." + type: boolean + country: + description: "Country name." + type: string + createad: + description: "Date when the document description was created in the database." + type: string + doc_type: + description: "Document type." + type: integer + document: + description: "Document name." + type: string + graphic_fields: + description: "The presence of graphic fields in the document." + type: boolean + id: + description: "Document code." + type: integer + mrz: + description: "The document has an MRZ." + type: boolean + region: + description: "Country region." + type: string + rfid_chip: + description: "The document has an RFID chip." + type: boolean + text_fields: + description: "The presence of text fields in the document." + type: boolean + updated: + description: "Date when the document description was updated in the database." + type: string + year: + description: "The year when the document was issued." + type: string + sovereignty: + description: "Guardian country." + type: string + deprecated: + description: "Whether the document has been withdrawn from circulation." + type: boolean From 0e8f7ed5666f5f803f83895cd4b0b9daeddb773e Mon Sep 17 00:00:00 2001 From: Artsiom Tsybulko Date: Tue, 28 Oct 2025 09:38:55 +0300 Subject: [PATCH 5/7] 45719 - add /api/doclist --- p-doclist.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/p-doclist.yml b/p-doclist.yml index dd008797..961271f6 100644 --- a/p-doclist.yml +++ b/p-doclist.yml @@ -52,8 +52,7 @@ components: description: "Date when the document description was created in the database." type: string doc_type: - description: "Document type." - type: integer + $ref: "./e-document-type.yml#/components/schemas/DocumentType" document: description: "Document name." type: string @@ -85,5 +84,5 @@ components: description: "Guardian country." type: string deprecated: - description: "Whether the document has been withdrawn from circulation." + description: "Whether the document is no longer in circulation." type: boolean From 8dd2d387cceba7fa0d30d1e5560a4e34c94d59e2 Mon Sep 17 00:00:00 2001 From: Artsiom Tsybulko Date: Tue, 28 Oct 2025 13:59:24 +0300 Subject: [PATCH 6/7] 44503 - add useCache query --- p-transaction.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/p-transaction.yml b/p-transaction.yml index 11bd1af1..8244aa5f 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -10,6 +10,12 @@ paths: format: uuid required: true description: Transaction id + - in: query + name: useCache + schema: + type: boolean + default: false + description: Get processed values from storage in case transaction has already processed. summary: Reprocess tags: - transaction From ddc72e314849cf6ded5f64910e0c501b7018f0ab Mon Sep 17 00:00:00 2001 From: Artsiom Tsybulko Date: Tue, 28 Oct 2025 17:07:46 +0300 Subject: [PATCH 7/7] 45829 - add returnTransliteratedFields --- p-process.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/p-process.yml b/p-process.yml index acd4fe8b..aa079866 100644 --- a/p-process.yml +++ b/p-process.yml @@ -467,6 +467,9 @@ components: strictSecurityChecks: description: "When enabled, this parameter marks security checks that don’t meet minimum requirements as 'Failed' (instead of 'WasNotDone'), which causes the overall security status to be 'Failed'." type: boolean + returnTransliteratedFields: + description: "Allows transliteration to be turned on or off; by default, it is enabled." + type: boolean MRZFormat: title: "MRZFormat"