@regulaforensics/document-reader-webclient 6.8.3 → 11.4.17

package/src/models/process-params.ts

@@ -16,6 +16,7 @@
 import { AuthenticityResultType } from './authenticity-result-type';
 import { DocumentFormat } from './document-format';
 import { DocumentType } from './document-type';
+import { FaceApi } from './face-api';
 import { ImageQA } from './image-qa';
 import { LogLevel } from './log-level';
 import { MRZFormat } from './mrzformat';
@@ -33,6 +34,30 @@ import { TextPostProcessing } from './text-post-processing';
  * @interface ProcessParams
  */
 export interface ProcessParams {
+    /**
+     * This parameter allows processing an image that contains a person and a document and compare the portrait photo from the document with the person\'s face
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    oneShotIdentification?: boolean;
+    /**
+     * This parameter allows comparing faces on Regula Face Web Service
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    useFaceApi?: boolean;
+    /**
+     * 
+     * @type {FaceApi}
+     * @memberof ProcessParams
+     */
+    faceApi?: FaceApi;
+    /**
+     * This parameter allows enabling the CAN (Card Access Number) detection and recognition when using scenarios with document location and MRZ reading, such as the MrzAndLocate scenario.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    doDetectCan?: boolean;
     /**
      * This parameter allows setting maximum height in pixels of output images and thus reducing image size to desired. Does not change the aspect ratio. Changes disabled if equals to 0. Default 0.
      * @type {number}

package/src/models/process-request.ts

@@ -42,6 +42,18 @@ export interface ProcessRequest {
      * @memberof ProcessRequest
      */
     List?: Array<ProcessRequestImage>;
+    /**
+     * Live portrait photo
+     * @type {string}
+     * @memberof ProcessRequest
+     */
+    livePortrait?: string;
+    /**
+     * Portrait photo from an external source
+     * @type {string}
+     * @memberof ProcessRequest
+     */
+    extPortrait?: string;
     /**
      * 
      * @type {ContainerList}

package/src/models/result.ts

@@ -15,7 +15,7 @@
 
 
 /**
- * Describes possible extracted result types from documents
+ * 
  * @export
  * @enum {string}
  */
@@ -25,25 +25,29 @@ export enum Result {
     */
     DOCUMENT_IMAGE = 1,
     /**
-    * Contains image quality check results
+    * Contains MRZ OCR results
     */
-    IMAGE_QUALITY = 30,
+    MRZ_TEXT = 3,
     /**
-    * Contains check statuses with details, grouped by source
+    * Contains raw information about barcodes on the input image
     */
-    STATUS = 33,
+    BARCODES = 5,
     /**
-    * Contains document textual fields from all sources (mrz, rfid, visual, barcode) with validity and cross-source compare checks
+    * Contains cropped graphic fields from Visual zone
     */
-    TEXT = 36,
+    VISUAL_GRAPHICS = 6,
     /**
-    * Contains images from all document sources (mrz, rfid, visual, barcode)
+    * Contains list of document type candidates with their probabilities and descriptions
     */
-    IMAGES = 37,
+    DOCUMENT_TYPE_CANDIDATES = 8,
     /**
-    * Contains MRZ OCR results
+    * Contains description of determined document type, if any
     */
-    MRZ_TEXT = 3,
+    DOCUMENT_TYPE = 9,
+    /**
+    * Contains lexical data analysis results that allow you to compare MRZ OCR results, Visual zone OCR results, barcodes and RFID chip data for an additional assessment of the authenticity of the document (this is an old format, better use TEXT type)
+    */
+    LEXICAL_ANALYSIS = 15,
     /**
     * Contains Visual zone OCR results
     */
@@ -53,53 +57,61 @@ export enum Result {
     */
     BARCODE_TEXT = 18,
     /**
-    * Contains RFID parsing result with text fields
+    * Contains barcode parsing result with graphic fields
     */
-    RFID_TEXT = 102,
+    BARCODE_GRAPHICS = 19,
     /**
-    * Contains lexical data analysis results that allow you to compare MRZ OCR results, Visual zone OCR results, barcodes and RFID chip data for an additional assessment of the authenticity of the document (this is an old format, better use TEXT type)
+    * Contains result of document authenticity checks
     */
-    LEXICAL_ANALYSIS = 15,
+    AUTHENTICITY = 20,
     /**
-    * Contains cropped graphic fields from Visual zone
+    * Contains image quality check results
     */
-    VISUAL_GRAPHICS = 6,
+    IMAGE_QUALITY = 30,
     /**
-    * Contains barcode parsing result with graphic fields
+    * Contains check statuses with details, grouped by source
     */
-    BARCODE_GRAPHICS = 19,
+    STATUS = 33,
     /**
-    * Contains RFID parsing result with graphic fields
+    * Contains document textual fields from all sources (mrz, rfid, visual, barcode) with validity and cross-source compare checks
     */
-    RFID_GRAPHICS = 103,
+    TEXT = 36,
     /**
-    * Contains list of document type candidates with their probabilities and descriptions
+    * Contains images from all document sources (mrz, rfid, visual, barcode)
     */
-    DOCUMENT_TYPE_CANDIDATES = 8,
+    IMAGES = 37,
     /**
-    * Contains description of determined document type, if any
+    * Contains encrypted ResultContainerList
     */
-    DOCUMENT_TYPE = 9,
+    ENCRYPTED_RCL = 49,
     /**
-    * Contains result of document authenticity checks
+    * Contains license
     */
-    AUTHENTICITY = 20,
+    LICENSE = 50,
     /**
     * Contains information about document position on the input image, its center, angle, etc
     */
     DOCUMENT_POSITION = 85,
     /**
-    * Contains raw information about barcodes on the input image
+    * Contains RFID raw data
     */
-    BARCODES = 5,
+    RFID_RAW_DATA = 101,
     /**
-    * Contains license
+    * Contains RFID text results
     */
-    LICENSE = 50,
+    RFID_TEXT = 102,
     /**
-    * Contains encrypted ResultContainerList
+    * Contains RFID graphic results
+    */
+    RFID_GRAPHICS = 103,
+    /**
+    * Contains RFID binary data
+    */
+    RFID_BINARY_DATA = 104,
+    /**
+    * Contains RFID original graphics data
     */
-    ENCRYPTED_RCL = 49
+    RFID_ORIGINAL_GRAPHICS = 105
 }
 
 

package/src/models/scenario.ts

@@ -20,24 +20,77 @@
  * @enum {string}
  */
 export enum Scenario {
+    /**
+    * Processing scenario for obtaining MRZ data
+    */
     MRZ = 'Mrz',
+    /**
+    * Processing scenario for obtaining barcode data
+    */
     BARCODE = 'Barcode',
+    /**
+    * Processing scenario for detecting document boundaries
+    */
     LOCATE = 'Locate',
+    /**
+    * Processing scenario for obtaining visual zone OCR results
+    */
     OCR = 'Ocr',
+    /**
+    * Processing scenario for document type recognition
+    */
     DOCTYPE = 'DocType',
+    /**
+    * Processing scenario for obtaining MRZ and/or barcode data
+    */
     MRZ_OR_BARCODE = 'MrzOrBarcode',
+    /**
+    * Processing scenario for detecting document boundaries and/or obtaining MRZ data
+    */
     MRZ_OR_LOCATE = 'MrzOrLocate',
+    /**
+    * Processing scenario for detecting document boundaries and obtaining MRZ data
+    */
     MRZ_AND_LOCATE = 'MrzAndLocate',
+    /**
+    * Processing scenario for detecting the document boundaries and obtaining barcode data
+    */
     BARCODE_AND_LOCATE = 'BarcodeAndLocate',
+    /**
+    * Processing scenario for obtaining MRZ data or visual zone OCR results
+    */
     MRZ_OR_OCR = 'MrzOrOcr',
+    /**
+    * Processing scenario for obtaining MRZ or barcode or visual zone OCR results
+    */
     MRZ_OR_BARCODE_OR_OCR = 'MrzOrBarcodeOrOcr',
+    /**
+    * Processing scenario for detecting document boundaries and obtaining MRZ data or visual zone OCR results
+    */
     LOCATE_VISUAL_AND_MRZ_OR_OCR = 'LocateVisual_And_MrzOrOcr',
+    /**
+    * Processing scenario for obtaining all document data
+    */
     FULL_PROCESS = 'FullProcess',
+    /**
+    * Processing scenario for obtaining all document data and document authentication
+    */
     FULL_AUTH = 'FullAuth',
-    ID3RUS = 'Id3Rus',
+    /**
+    * Processing scenario for obtaining data from registration stamps
+    */
     RUS_STAMP = 'RusStamp',
+    /**
+    * Processing scenario for obtaining OCR results of any image
+    */
     OCR_FREE = 'OcrFree',
+    /**
+    * Processing scenario for obtaining bank card data
+    */
     CREDIT_CARD = 'CreditCard',
+    /**
+    * Scenario for obtaining an original image without any processing
+    */
     CAPTURE = 'Capture'
 }
 

package/src/models/security-feature-type.ts

@@ -20,50 +20,186 @@
  * @enum {string}
  */
 export enum SecurityFeatureType {
+    /**
+    * Blank element
+    */
     BLANK = 0,
+    /**
+    * Personalization element
+    */
     FILL = 1,
+    /**
+    * Photo
+    */
     PHOTO = 2,
+    /**
+    * MRZ
+    */
     MRZ = 3,
+    /**
+    * False luminescence
+    */
     FALSE_LUMINESCENCE = 4,
+    /**
+    * Hologram (static)
+    */
     HOLO_SIMPLE = 5,
+    /**
+    * Hologram (static verify)
+    */
     HOLO_VERIFY_STATIC = 6,
+    /**
+    * Hologram (static verify multiple)
+    */
     HOLO_VERIFY_MULTI_STATIC = 7,
+    /**
+    * Hologram (dynamic verify)
+    */
     HOLO_VERIFY_DYNAMIC = 8,
+    /**
+    * Pattern (non-interrupted)
+    */
     PATTERN_NOT_INTERRUPTED = 9,
+    /**
+    * Pattern (non-shifted)
+    */
     PATTERN_NOT_SHIFTED = 10,
+    /**
+    * Pattern (same colors)
+    */
     PATTERN_SAME_COLORS = 11,
+    /**
+    * Pattern (IR invisible)
+    */
     PATTERN_IR_INVISIBLE = 12,
+    /**
+    * Photo size
+    */
     PHOTO_SIZE_CHECK = 13,
+    /**
+    * Main vs ghost portrait comparison
+    */
     PORTRAIT_COMPARISON_VS_GHOST = 14,
+    /**
+    * Main vs RFID portrait comparison
+    */
     PORTRAIT_COMPARISON_VS_RFID = 15,
+    /**
+    * Main vs other page portrait comparison
+    */
     PORTRAIT_COMPARISON_VS_VISUAL = 16,
+    /**
+    * Barcode
+    */
     BARCODE = 17,
+    /**
+    * Pattern (different line thickness)
+    */
     PATTERN_DIFFERENT_LINES_THICKNESS = 18,
+    /**
+    * Main vs live camera portrait comparison
+    */
     PORTRAIT_COMPARISON_VS_CAMERA = 19,
+    /**
+    * RFID vs live camera portrait comparison
+    */
     PORTRAIT_COMPARISON_RFID_VS_CAMERA = 20,
+    /**
+    * Ghost photo
+    */
     GHOST_PHOTO = 21,
+    /**
+    * Clear ghost photo
+    */
     CLEAR_GHOST_PHOTO = 22,
+    /**
+    * Invisible object
+    */
     INVISIBLE_OBJECT = 23,
+    /**
+    * Low contrast object
+    */
     LOW_CONTRAST_OBJECT = 24,
+    /**
+    * Photo color check
+    */
     PHOTO_COLOR = 25,
+    /**
+    * Photo squareness
+    */
     PHOTO_SHAPE = 26,
+    /**
+    * Photo corners shape
+    */
     PHOTO_CORNERS = 27,
+    /**
+    * OCR
+    */
     OCR = 28,
+    /**
+    * External vs main portrait comparison
+    */
     PORTRAIT_COMPARISON_EXT_VS_VISUAL = 29,
+    /**
+    * External vs RFID portrait comparison
+    */
     PORTRAIT_COMPARISON_EXT_VS_RFID = 30,
+    /**
+    * External vs live camera portrait comparison
+    */
     PORTRAIT_COMPARISON_EXT_VS_CAMERA = 31,
+    /**
+    * Portrait Depth
+    */
     LIVENESS_DEPTH = 32,
+    /**
+    * Micro text
+    */
     MICRO_TEXT = 33,
+    /**
+    * Fluorescent Object
+    */
     FLUORESCENT_OBJECT = 34,
+    /**
+    * Facial landmarks check
+    */
     LANDMARK_CHECK = 35,
+    /**
+    * Facial image presence
+    */
     FACE_PRESENCE = 36,
+    /**
+    * Facial image absence
+    */
     FACE_ABSENCE = 38,
+    /**
+    * Liveness screen capture
+    */
     LIVENESS_SCREEN_CAPTURE = 39,
+    /**
+    * Liveness electronic device
+    */
     LIVENESS_ELECTRONIC_DEVICE = 40,
+    /**
+    * Liveness OVI
+    */
     LIVENESS_OVI = 41,
+    /**
+    * Barcode size check
+    */
     BARCODE_SIZE_CHECK = 42,
+    /**
+    * LASINK
+    */
     LASINK = 43,
-    LIVENESS_MLI = 44
+    /**
+    * Liveness MLI
+    */
+    LIVENESS_MLI = 44,
+    /**
+    * Liveness barcode background
+    */
+    LIVENESS_BARCODE_BACKGROUND = 45
 }
 
 

package/src/models/source.ts

@@ -20,10 +20,25 @@
  * @enum {string}
  */
 export enum Source {
+    /**
+    * Machine readable zone (MRZ)
+    */
     MRZ = 'MRZ',
+    /**
+    * Visual zone
+    */
     VISUAL = 'VISUAL',
+    /**
+    * Barcode
+    */
     BARCODE = 'BARCODE',
+    /**
+    * RFID
+    */
     RFID = 'RFID',
+    /**
+    * Magnetic
+    */
     MAGNETIC = 'MAGNETIC'
 }