From b0e27b2d49b8fe0b4753e4098944283d946d85d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Pe=C5=A1ek?= Date: Wed, 17 Jan 2024 11:11:41 +0100 Subject: [PATCH] Fix #964: Modify verification providers documentation (#996) --- .../Configuration-Verification-Providers.md | 41 +++++++++++++++++-- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/docs/onboarding/Configuration-Verification-Providers.md b/docs/onboarding/Configuration-Verification-Providers.md index ed358b8bd..09d045190 100644 --- a/docs/onboarding/Configuration-Verification-Providers.md +++ b/docs/onboarding/Configuration-Verification-Providers.md @@ -11,7 +11,7 @@ The document verification process is currently supported for following providers ### ZenID -#### Configuration - API key +#### API key The authorization of all API calls is secured by an API key value. It has to be sent as the `Authorization: api_key VALUE` header value. Check the bottom of the `Manual/Configuration` page for more details. @@ -21,7 +21,7 @@ The API key value can be configured/get from the `Access` page configuration: - Condition: `ApiKeyEqualsValue` - Value: the value here is the value of the API key -#### Configuration - Validators +#### Validators It is recommended to create a custom validation profile. The sensitivity of selected validators can be tuned-up or disabled completely at the `Sensitivity` page. The profile can be then set as the default or specified in the configuration properties. @@ -32,6 +32,41 @@ When calling `document-verification/init-sdk` following implementation fields ar - Init token - send a token value `sdk-init-token` in the request body `attributes` map field - SDK response - receive the value under `zenid-sdk-init-response` from the response `attributes` map field +### Innovatrics + +Innovatrics documentation for developers can be found at [this link](https://developers.innovatrics.com/digital-onboarding/technical/remote/dot-dis/latest/documentation/). + +#### OCR Threshold + +During a document validation Innovatrics provides a list of fields extracted from the document, that have OCR +confidence lower than configurable threshold. If the list is not empty, there is a high probability that some +information is read incorrectly. For that reason, this document will be rejected. The OCR confidence threshold is `0.92` +by default, and can be tuned using `innovatrics.dot.dis.customer.document.inspection.ocr-text-field-threshold`. + +#### Text Consistency + +For each document Innovatrics tries to read visual zone, machine-readable zone and barcode. These isolated parts are +cross-checked during a document validation by Innovatrics. If there are inconsistency between visual zone and +machine-readable zone, or between visual-zone and barcode, the document will be rejected. However, some editions of +identification documents are inconsistent by design. To prevent false rejection of those document modify the +configuration. +Following example excludes `issuingAuthority` field of Czech identity card 2005 edition from text consistency check: + +```yml +innovatrics: + dot: + dis: + customer: + document: + inspection: + text-consistency-check: + CZE_identity-card_2005-01-01: + exclusions: + - issuingAuthority +``` + +The format of the document name is `{country}_{type}_{edition}` according to the response of `/metadata` request. + ## Presence Check The document verification process is currently supported for following providers: @@ -39,7 +74,7 @@ The document verification process is currently supported for following providers - [Innovatrics](https://www.innovatrics.com/) - use value `innovatrics` in configuration - Mock - useful for simple testing and local runs - use value `mock` in configuration -#### Configuration +### iProov There are a few needed configuration changes to bring a successful integration. All the following configuration tuning has to be requested from the iProov's [support team](https://iproov.freshdesk.com/support/login) on a per-service basis: