Commit: d3fac7e8

client/src/main/generated/com/regula/documentreader/webclient/model/ChosenDocumentType.java

@@ -191,7 +191,7 @@ public ChosenDocumentType rfIDPresence(@javax.annotation.Nonnull RfidLocation rf
   }
 
   /**
-   * Get rfIDPresence
+   * Indication of the presence of an RFID chip in the document (electronic document indicator)
    *
    * @return rfIDPresence
    */

client/src/main/generated/com/regula/documentreader/webclient/model/DetailsOptical.java

@@ -94,7 +94,7 @@ public DetailsOptical overallStatus(@javax.annotation.Nonnull CheckResult overal
   }
 
   /**
-   * Get overallStatus
+   * Overall optical checks combined status
    *
    * @return overallStatus
    */
@@ -113,7 +113,7 @@ public DetailsOptical docType(@javax.annotation.Nonnull CheckResult docType) {
   }
 
   /**
-   * Get docType
+   * Status of document type recognition
    *
    * @return docType
    */
@@ -132,7 +132,7 @@ public DetailsOptical expiry(@javax.annotation.Nonnull CheckResult expiry) {
   }
 
   /**
-   * Get expiry
+   * Status of document expiration
    *
    * @return expiry
    */
@@ -151,7 +151,7 @@ public DetailsOptical imageQA(@javax.annotation.Nonnull CheckResult imageQA) {
   }
 
   /**
-   * Get imageQA
+   * Status of document image quality check
    *
    * @return imageQA
    */
@@ -170,7 +170,7 @@ public DetailsOptical mrz(@javax.annotation.Nonnull CheckResult mrz) {
   }
 
   /**
-   * Get mrz
+   * Status of document MRZ
    *
    * @return mrz
    */
@@ -208,7 +208,7 @@ public DetailsOptical security(@javax.annotation.Nonnull CheckResult security) {
   }
 
   /**
-   * Get security
+   * Authenticity verification status
    *
    * @return security
    */
@@ -227,7 +227,7 @@ public DetailsOptical text(@javax.annotation.Nonnull CheckResult text) {
   }
 
   /**
-   * Get text
+   * Status of text fields analysis
    *
    * @return text
    */

client/src/main/generated/com/regula/documentreader/webclient/model/DetailsRFID.java

@@ -82,7 +82,7 @@ public DetailsRFID overallStatus(@javax.annotation.Nonnull CheckResult overallSt
   }
 
   /**
-   * Get overallStatus
+   * Overall RFID checks combined status
    *
    * @return overallStatus
    */
@@ -101,7 +101,7 @@ public DetailsRFID AA(@javax.annotation.Nonnull CheckResult AA) {
   }
 
   /**
-   * Get AA
+   * Active Authentication status
    *
    * @return AA
    */
@@ -120,7 +120,7 @@ public DetailsRFID BAC(@javax.annotation.Nonnull CheckResult BAC) {
   }
 
   /**
-   * Get BAC
+   * Basic Access Control (BAC) status
    *
    * @return BAC
    */
@@ -139,7 +139,7 @@ public DetailsRFID CA(@javax.annotation.Nonnull CheckResult CA) {
   }
 
   /**
-   * Get CA
+   * Chip Authentication status
    *
    * @return CA
    */
@@ -158,7 +158,7 @@ public DetailsRFID PA(@javax.annotation.Nonnull CheckResult PA) {
   }
 
   /**
-   * Get PA
+   * Passive Authentication status
    *
    * @return PA
    */
@@ -177,7 +177,7 @@ public DetailsRFID PACE(@javax.annotation.Nonnull CheckResult PACE) {
   }
 
   /**
-   * Get PACE
+   * Password Authenticated Connection Establishment (PACE) status
    *
    * @return PACE
    */
@@ -196,7 +196,7 @@ public DetailsRFID TA(@javax.annotation.Nonnull CheckResult TA) {
   }
 
   /**
-   * Get TA
+   * Terminal Authentication status
    *
    * @return TA
    */

client/src/main/generated/com/regula/documentreader/webclient/model/DocVisualExtendedField.java

@@ -47,7 +47,8 @@ public DocVisualExtendedField fieldRect(
   }
 
   /**
-   * Get fieldRect
+   * Coordinates of the text field in the normalized image of the document. Only for
+   * Result.VISUAL_TEXT and Result.MRZ_TEXT results.
    *
    * @return fieldRect
    */

client/src/main/generated/com/regula/documentreader/webclient/model/DocVisualExtendedFieldItem.java

@@ -47,7 +47,8 @@ public DocVisualExtendedFieldItem fieldRect(
   }
 
   /**
-   * Get fieldRect
+   * Coordinates of the text field in the normalized image of the document. Only for
+   * Result.VISUAL_TEXT and Result.MRZ_TEXT results.
    *
    * @return fieldRect
    */

client/src/main/generated/com/regula/documentreader/webclient/model/DocumentFormat.java

@@ -44,6 +44,9 @@ public enum DocumentFormat {
   /** ID3 double document format */
   ID3_X2(5),
 
+  /** Turkey ID2 card */
+  ID2_TURKEY(6),
+
   /** ID1 format document rotated 90 ° */
   ID1_90(10),
 
@@ -53,7 +56,7 @@ public enum DocumentFormat {
   /** ID1 format document rotated 270 ° */
   ID1_270(12),
 
-  /** ID2 format document rotated 90 ° */
+  /** ID2 format document rotated 180 ° */
   ID2_180(13),
 
   /** ID3 format document rotated 180 ° */

client/src/main/generated/com/regula/documentreader/webclient/model/DocumentTypesCandidates.java

@@ -56,7 +56,7 @@ public DocumentTypesCandidates recResult(
   }
 
   /**
-   * Get recResult
+   * Overall recognition result
    *
    * @return recResult
    */

client/src/main/generated/com/regula/documentreader/webclient/model/DocumentTypesCandidatesList.java

@@ -56,7 +56,7 @@ public DocumentTypesCandidatesList recResult(
   }
 
   /**
-   * Get recResult
+   * Overall recognition result
    *
    * @return recResult
    */

client/src/main/generated/com/regula/documentreader/webclient/model/FiberItem.java

@@ -135,7 +135,7 @@ public FiberItem lightValue(@javax.annotation.Nullable Light lightValue) {
   }
 
   /**
-   * Get lightValue
+   * For UV_Background authentication result type
    *
    * @return lightValue
    */
@@ -289,7 +289,7 @@ public FiberItem addColorValuesItem(Integer colorValuesItem) {
   }
 
   /**
-   * Fibers color value
+   * Fibers color value. Example: [BLUE, GREEN, RED]
    *
    * @return colorValues
    */

client/src/main/generated/com/regula/documentreader/webclient/model/FiberResult.java

@@ -134,7 +134,7 @@ public FiberResult lightValue(@javax.annotation.Nullable Light lightValue) {
   }
 
   /**
-   * Get lightValue
+   * For UV_Background authentication result type
    *
    * @return lightValue
    */
@@ -288,7 +288,7 @@ public FiberResult addColorValuesItem(Integer colorValuesItem) {
   }
 
   /**
-   * Fibers color value
+   * Fibers color value. Example: [BLUE, GREEN, RED]
    *
    * @return colorValues
    */

client/src/main/generated/com/regula/documentreader/webclient/model/IdentItem.java

@@ -139,7 +139,7 @@ public IdentItem image(@javax.annotation.Nonnull ImageData image) {
   }
 
   /**
-   * Get image
+   * Original image
    *
    * @return image
    */
@@ -158,7 +158,7 @@ public IdentItem etalonImage(@javax.annotation.Nonnull ImageData etalonImage) {
   }
 
   /**
-   * Get etalonImage
+   * Reference image
    *
    * @return etalonImage
    */

client/src/main/generated/com/regula/documentreader/webclient/model/IdentResult.java

@@ -139,7 +139,7 @@ public IdentResult image(@javax.annotation.Nonnull ImageData image) {
   }
 
   /**
-   * Get image
+   * Original image
    *
    * @return image
    */
@@ -158,7 +158,7 @@ public IdentResult etalonImage(@javax.annotation.Nonnull ImageData etalonImage)
   }
 
   /**
-   * Get etalonImage
+   * Reference image
    *
    * @return etalonImage
    */

client/src/main/generated/com/regula/documentreader/webclient/model/ImageQualityCheckList.java

@@ -62,7 +62,7 @@ public ImageQualityCheckList result(@javax.annotation.Nonnull CheckResult result
   }
 
   /**
-   * Get result
+   * Overall image quality status, combined from check statuses in the list.
    *
    * @return result
    */

client/src/main/generated/com/regula/documentreader/webclient/model/ImagesFieldValue.java

@@ -132,7 +132,7 @@ public ImagesFieldValue originalValue(@javax.annotation.Nullable String original
   }
 
   /**
-   * Base64 encoded image
+   * Only for images from RFID. Image as was originally stored in the RFID chip.
    *
    * @return originalValue
    */
@@ -227,7 +227,7 @@ public ImagesFieldValue fieldRect(@javax.annotation.Nullable RectangleCoordinate
   }
 
   /**
-   * Get fieldRect
+   * Only for images from VISUAL. Coordinates of the image in the normalized image of the document.
    *
    * @return fieldRect
    */
@@ -246,7 +246,7 @@ public ImagesFieldValue rfidOrigin(@javax.annotation.Nullable RfidOrigin rfidOri
   }
 
   /**
-   * Get rfidOrigin
+   * Only for images from RFID. Image location in RFID chip.
    *
    * @return rfidOrigin
    */

client/src/main/generated/com/regula/documentreader/webclient/model/OneCandidate.java

@@ -191,7 +191,7 @@ public OneCandidate rfIDPresence(@javax.annotation.Nonnull RfidLocation rfIDPres
   }
 
   /**
-   * Get rfIDPresence
+   * Indication of the presence of an RFID chip in the document (electronic document indicator)
    *
    * @return rfIDPresence
    */

client/src/main/generated/com/regula/documentreader/webclient/model/ProcessParams.java

@@ -840,7 +840,8 @@ public ProcessParams measureSystem(@javax.annotation.Nullable MeasureSystem meas
   }
 
   /**
-   * Get measureSystem
+   * This option allows you to set the system of measurement used for converting original values in
+   * document to output result values. Metric by default.
    *
    * @return measureSystem
    */
@@ -977,7 +978,8 @@ public ProcessParams logLevel(@javax.annotation.Nullable LogLevel logLevel) {
   }
 
   /**
-   * Get logLevel
+   * When used together with 'log' parameter enabled, sets the level of logs detalization.
+   * 'INFO' by default.
    *
    * @return logLevel
    */
@@ -1189,7 +1191,8 @@ public ProcessParams forceDocFormat(@javax.annotation.Nullable DocumentFormat fo
   }
 
   /**
-   * Get forceDocFormat
+   * Force use of specified document format when locating and recognizing document to reduce the
+   * number of candidates.
    *
    * @return forceDocFormat
    */
@@ -1376,7 +1379,8 @@ public ProcessParams convertCase(@javax.annotation.Nullable TextPostProcessing c
   }
 
   /**
-   * Get convertCase
+   * This option allows output text case transformation. No changes applied by default to original
+   * values.
    *
    * @return convertCase
    */

client/src/main/generated/com/regula/documentreader/webclient/model/RfidApplicationType.java

@@ -53,10 +53,10 @@ public enum RfidApplicationType {
   /** Digital Travel Credentials */
   eDTC_PC(8),
 
-  /** Master File */
+  /** Applet root */
   APPLET_ROOT(50),
 
-  /** Applet root */
+  /** User defined */
   USER_DEFINED(100);
 
   private Integer value;