@regulaforensics/vp-frontend-document-components 2.1.0 → 2.3.0

package/README.md

@@ -117,7 +117,7 @@ window.RegulaDocumentSDK.recognizerProcessParam = {
       returnUncroppedImage: true,
       scenario: 'MrzAndLocate',
       multipageProcessing: false,
-      returnPackagesForReprocess: false,
+      returnPackageForReprocess: false,
       timeout: 20000,
       resultTypeOutput: [],
       imageQa: {
@@ -137,26 +137,51 @@ window.RegulaDocumentSDK.imageProcessParam = {
    processParam: {
       scenario: 'MrzAndLocate',
       returnUncroppedImage: true,
-      returnPackagesForReprocess: false,
+      returnPackageForReprocess: false,
    },
 };
 ```
 
-## Descriptions of settings
-
-| Setting                        | Info                                                                                                                                                      | Data type |                 Default value                 |                                                                                                                                                                                                                                                                                                 Values                                                                                                                                                                                                                                                                                                 |
-|:-------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:|:---------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
-| **returnUncroppedImage**       | When enabled, returns input images in output.                                                                                                             |  boolean  |                  ```true```                   |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |
-| **scenario**                   | Recognition scenario.                                                                                                                                     |  string   |              ```MrzAndLocate```               |                                                                                                                                                                                                                                                                 ```'MrzAndLocate'```, ```'MrzOrLocate'```, ```'Mrz'```, ```'Locate'```                                                                                                                                                                                                                                                                 |                                                                                                  
-| **multipageProcessing**        | Enables multi-page document processing mode.                                                                                                              |  boolean  |                  ```true```                   |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
-| **timeout**                    | Recognition timeout in milliseconds. After this time process will be finished.                                                                            |  number   |                     2000                      |                                                                                                                                                                                                                                                                                              numbers > 0                                                                                                                                                                                                                                                                                               |                                                                                                  
-| **resultTypeOutput**           | Types of results to return in response. [] - all available types.                                                                                         | number[]  |                      []                       | ```1``` - DocumentImageResult, ```3``` - TextDataResult, ```5``` - DocBarCodeInfo, ```6``` - GraphicsResult, ```8``` - DocumentTypesCandidatesResult, ```9``` - ChosenDocumentTypeResult, ```20``` - AuthenticityResult, ```15``` - LexicalAnalysisResult, ```17``` - TextDataResult, ```18``` - TextDataResult, ```19``` - GraphicsResult, ```30``` - ImageQualityResult, ```33``` - StatusResult, ```36``` - TextResult, ```37``` - ImagesResult, ```85``` - DocumentPositionResult, ```102``` - TextDataResult, ```103``` - GraphicsResult, ```50``` - LicenseResult, ```49``` - EncryptedRCLResult |                                                                                                  
-| **returnPackagesForReprocess** | Enable returning the package for reprocessing on the backend.                                                                                             |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
-| **imageQa**                    | When enabled, image quality checks status affects document optical and overall status.                                                                    |           |                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                  
-| **expectedPass**               | Activated image quality checks.                                                                                                                           | string[]  | ['dpiThreshold', 'glaresCheck', 'focusCheck'] |                                                                                                                                                                                                                                                                        ```dpiThreshold```, ```glaresCheck```, ```focusCheck```                                                                                                                                                                                                                                                                         |                                                                                                  
-| **dpiThreshold**               | This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail. |  number   |                      150                      |                                                                                                                                                                                                                                                                                              numbers > 0                                                                                                                                                                                                                                                                                               |                                                                                                  
-| **glaresCheck**                | This option enables glares check while performing image quality validation.                                                                               |  boolean  |                  ```true```                   |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
-| **glaresCheckParams**          | Settings for glare check.                                                                                                                                 |           |                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                  
+#### Descriptions of settings
+
+| Setting                           | Info                                                                                                                                                                                                                                                                                                                                                                                                                                  | Data type |                 Default value                 |                                                                                                                                                                                                                                                                                                 Values                                                                                                                                                                                                                                                                                                 |
+|:----------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:|:---------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| **returnUncroppedImage**          | When enabled, returns input images in output.                                                                                                                                                                                                                                                                                                                                                                                         |  boolean  |                  ```true```                   |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |
+| **scenario**                      | Recognition scenario.                                                                                                                                                                                                                                                                                                                                                                                                                 |  string   |                'MrzAndLocate'                 |                                                                                                                                                                                                                                                                             'MrzAndLocate', 'MrzOrLocate', 'Mrz', 'Locate'                                                                                                                                                                                                                                                                             |                                                                                                  
+| **multipageProcessing**           | Enables multi-page document processing mode.                                                                                                                                                                                                                                                                                                                                                                                          |  boolean  |                  ```true```                   |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **timeout**                       | Recognition timeout in milliseconds. After this time process will be finished.                                                                                                                                                                                                                                                                                                                                                        |  number   |                     2000                      |                                                                                                                                                                                                                                                                                              numbers > 0                                                                                                                                                                                                                                                                                               |                                                                                                  
+| **resultTypeOutput**              | Types of results to return in response. [] - all available types.                                                                                                                                                                                                                                                                                                                                                                     | number[]  |                      []                       | ```1``` - DocumentImageResult, ```3``` - TextDataResult, ```5``` - DocBarCodeInfo, ```6``` - GraphicsResult, ```8``` - DocumentTypesCandidatesResult, ```9``` - ChosenDocumentTypeResult, ```20``` - AuthenticityResult, ```15``` - LexicalAnalysisResult, ```17``` - TextDataResult, ```18``` - TextDataResult, ```19``` - GraphicsResult, ```30``` - ImageQualityResult, ```33``` - StatusResult, ```36``` - TextResult, ```37``` - ImagesResult, ```85``` - DocumentPositionResult, ```102``` - TextDataResult, ```103``` - GraphicsResult, ```50``` - LicenseResult, ```49``` - EncryptedRCLResult |                                                                                                  
+| **returnPackageForReprocess**     | Enable returning the package for reprocessing on the backend.                                                                                                                                                                                                                                                                                                                                                                         |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **imageQa**                       | When enabled, image quality checks status affects document optical and overall status.                                                                                                                                                                                                                                                                                                                                                |           |                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                  
+| **expectedPass**                  | Activated image quality checks.                                                                                                                                                                                                                                                                                                                                                                                                       | string[]  | ['dpiThreshold', 'glaresCheck', 'focusCheck'] |                                                                                                                                                                                                                                                                              'dpiThreshold', 'glaresCheck', 'focusCheck'                                                                                                                                                                                                                                                                               |                                                                                                  
+| **dpiThreshold**                  | This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail.                                                                                                                                                                                                                                                                             |  number   |                      150                      |                                                                                                                                                                                                                                                                                              numbers > 0                                                                                                                                                                                                                                                                                               |                                                                                                  
+| **glaresCheck**                   | This option enables glares check while performing image quality validation.                                                                                                                                                                                                                                                                                                                                                           |  boolean  |                  ```true```                   |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **glaresCheckParams**             | Settings for glare check.                                                                                                                                                                                                                                                                                                                                                                                                             |           |                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                  
+| **imageOutputMaxHeight**          | 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.                                                                                                                                                                                                                                                   |  number   |                       0                       |                                                                                                                                                                                                                                                                                              numbers > 0                                                                                                                                                                                                                                                                                               |                                                                                                  
+| **imageOutputMaxWidth**           | This parameter allows setting maximum width in pixels of output images and thus reducing image size to desired. Does not change the aspect ratio. Changes disabled if equals to 0.                                                                                                                                                                                                                                                    |  number   |                       0                       |                                                                                                                                                                                                                                                                                              numbers > 0                                                                                                                                                                                                                                                                                               |                                                                                                  
+| **doublePageSpread**              | Enable this option if the image you provide contains double page spread of the passport and you want to process both pages in one go. It makes sense to use it for documents that have meaningful information on both pages, like Russian domestic passport, or some others.                                                                                                                                                          |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **generateDoublePageSpreadImage** | When enabled together with "doublePageSpread" and there is a passport with two pages spread in the image, pages will be cropped, straightened and aligned together, as if the document was captured on a flatbed scanner.                                                                                                                                                                                                             |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **fieldTypesFilter**              | List of text field types to extract. If empty, all text fields from template will be extracted. Narrowing the list can shorten processing time.                                                                                                                                                                                                                                                                                       | number[]  |                      []                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                  
+| **dateFormat**                    | This option allows you to set dates format so that solution will return dates in this format. For example, if you supply 'MM/dd/yyyy', and document have printed date '09 JUL 2020' for the date os issue, you will get '07/09/2020' as a result. By default it is set to system locale default (where the service is running).                                                                                                       |  string   |                                               |                                                                                                                                                                                                                                                                                              'MM/dd/yyyy'                                                                                                                                                                                                                                                                                              |                                                                                                  
+| **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.                                                                                                                                                                                                                                                                                   |  number   |                       0                       |                                                                                                                                                                                                                                                                                  ```0``` - Metric, ```1``` - Imperial                                                                                                                                                                                                                                                                                  |                                                                                                  
+| **imageDpiOutMax**                | This parameter controls maximum resolution in dpi of output images. Resolution will remain original in case 0 is supplied. By default is set to return images in response with resolution not greater than 300 dpi for all scenarios except FullAuth. In FullAuth scenario this limit is 1000 dpi by default.                                                                                                                         |  number   |                                               |                                                                                                                                                                                                                                                                                              numbers > 0                                                                                                                                                                                                                                                                                               |                                                                                                  
+| **alreadyCropped**                | This option can be enabled if you know for sure that the image you provide contains already cropped document by its edges. This was designed to process on the server side images captured and cropped on mobile.                                                                                                                                                                                                                     |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **customParams**                  | This option allows passing custom processing parameters that can be implemented in future without changing API.                                                                                                                                                                                                                                                                                                                       |  Object   |                      {}                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                  
+| **fastDocDetect**                 | When enabled, shorten the list of candidates to process during document detection in a single image process mode. Reduces processing time for specific backgrounds.                                                                                                                                                                                                                                                                   |  boolean  |                  ```true```                   |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **updateOCRValidityByGlare**      | When enabled, fail OCR field validity, if there is a glare over the text field on the image.                                                                                                                                                                                                                                                                                                                                          |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **returnCroppedBarcode**          | When enabled, returns cropped barcode images for unknown documents.                                                                                                                                                                                                                                                                                                                                                                   |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **respectImageQuality**           | When enabled, image quality checks status affects document optical and overall status.                                                                                                                                                                                                                                                                                                                                                |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **forceDocFormat**                | Force use of specified document format when locating and recognizing document to reduce the number of candidates.                                                                                                                                                                                                                                                                                                                     |  number   |                                               | ```0``` - ID1 document format, ```1``` - ID2 document format, ```2``` - ID3 document format, ```3``` - Undefined document format, ```4``` - A4 document format, ```5``` - ID3 double document format, ```10``` - ID1 format document rotated 90°, ```11``` - ID1 format document rotated 180°, ```12``` - ID1 format document rotated 270°, ```13``` - ID2 format document rotated 90°, ```14``` - ID3 format document rotated 180°, ```1000``` - Arbitrary format, ```1002``` - Flexible format. Standard formats can be resized during cropping, depending on various factors: light, background...  |                                                                                                  
+| **noGraphics**                    | When enabled, no graphic fields will be cropped from document image.                                                                                                                                                                                                                                                                                                                                                                  |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **documentAreaMin**               | Specifies minimal area of the image that document should cover to be treated as candidate when locating. Value should be in range from 0 to 1, where 1 is when document should fully cover the image.                                                                                                                                                                                                                                 |  number   |                       0                       |                                                                                                                                                                                                                                                                                                 0 - 1                                                                                                                                                                                                                                                                                                  |                                                                                                  
+| **depersonalizeLog**              | When enabled, all personal data will be forcibly removed from the logs.                                                                                                                                                                                                                                                                                                                                                               |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **multiDocOnImage**               | This option allows locating and cropping multiple documents from one image if enabled.                                                                                                                                                                                                                                                                                                                                                |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **shiftExpiryDate**               | This option allows shifting the date of expiry into the future or past for number of months specified. This is useful, for example, in some cases when document might be still valid for some period after original expiration date to prevent negative validity status for such documents. Or by shifting the date to the past will set negative validity for the documents that is about to expire in a specified number of months. |  number   |                       0                       |                                                                                                                                                                                                                                                                                              numbers > 0                                                                                                                                                                                                                                                                                               |                                                                                                  
+| **minimalHolderAge**              | This options allows specifying the minimal age in years of the document holder for the document to be considered valid.                                                                                                                                                                                                                                                                                                               |  number   |                       0                       |                                                                                                                                                                                                                                                                                              numbers > 0                                                                                                                                                                                                                                                                                               |                                                                                                  
+| **mrzFormatsFilter**              | This option allows limiting MRZ formats to be recognized by specifying them in array.                                                                                                                                                                                                                                                                                                                                                 | string[]  |                      []                       |                                                                                                                                                                                                                                       ```'1x30'``` - IDL, ```'3x30'``` - ID1, ```'2x36'``` - ID2, ```'2x44'``` - ID3, ```'1x6'``` - CAN, ```'2x30'``` - ID1 2x30                                                                                                                                                                                                                                       |                                                                                                  
+| **forceReadMrzBeforeLocate**      | When enabled, make sure that in series processing MRZ is located fully inside the result document image, if present on the document. Enabling this option may add extra processing time, by disabling optimizations, but allows more stability in output image quality.                                                                                                                                                               |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **parseBarcodes**                 | This option can be disabled to stop parsing after barcode is read.                                                                                                                                                                                                                                                                                                                                                                    |  boolean  |                  ```true```                   |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **splitNames**                    | When enabled, the Surname and GivenNames field will be divided into ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields.                                                                                                                                                                                                                                                                                |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
 
 **Attention!** If the ```multipage-processing``` or ```internal-scenario``` attributes are set, the ```multipageProcessing``` and ```scenario``` settings will be ignored.
 
@@ -188,23 +213,25 @@ The generated event object (```event.detail```) contains three fields that descr
 
 Type of actions:
 
-| Type of action            |       Description of the action       |        In which component is present         |
-|:--------------------------|:-------------------------------------:|:--------------------------------------------:|
-| ```ELEMENT_VISIBLE```     |   Component is appended in the DOM.   | ```document-reader```, ```camera-snapshot``` |
-| ```PRESS_CAMERA_BUTTON``` | The "From camera" button is pressed.  | ```document-reader```, ```camera-snapshot``` |
-| ```PRESS_FILE_BUTTON```   | The "From gallery" button is pressed. | ```document-reader```, ```camera-snapshot``` |
-| ```PRESS_RETRY_BUTTON```  |    The "Retry" button is pressed.     | ```document-reader```, ```camera-snapshot``` |
-| ```PRESS_SKIP_BUTTON```   |     The "Skip" button is pressed.     |            ```document-reader```             |
-| ```CLOSE```               |    The "Close" button is pressed.     | ```document-reader```, ```camera-snapshot``` |
-| ```PROCESS_FINISHED```    | The component has finished its work.  | ```document-reader```, ```camera-snapshot``` |
-| ```SERVICE_INITIALIZED``` |  The component has started its work.  |            ```document-reader```             |
+| Type of action               |                     Description of the action                     |        In which component is present         |
+|:-----------------------------|:-----------------------------------------------------------------:|:--------------------------------------------:|
+| ```ELEMENT_VISIBLE```        |                 Component is appended in the DOM.                 | ```document-reader```, ```camera-snapshot``` |
+| ```PRESS_CAMERA_BUTTON```    |               The "From camera" button is pressed.                | ```document-reader```, ```camera-snapshot``` |
+| ```PRESS_FILE_BUTTON```      |               The "From gallery" button is pressed.               | ```document-reader```, ```camera-snapshot``` |
+| ```PRESS_RETRY_BUTTON```     |                  The "Retry" button is pressed.                   | ```document-reader```, ```camera-snapshot``` |
+| ```PRESS_SKIP_BUTTON```      |                   The "Skip" button is pressed.                   |            ```document-reader```             |
+| ```CLOSE```                  |                  The "Close" button is pressed.                   | ```document-reader```, ```camera-snapshot``` |
+| ```CAMERA_PROCESS_STARTED``` |             Recognition from the camera has started.              | ```document-reader```, ```camera-snapshot``` |
+| ```FILE_PROCESS_STARTED```   |                   File processing has started.                    | ```document-reader```, ```camera-snapshot``` |
+| ```PROCESS_FINISHED```       |               The component has finished its work.                | ```document-reader```, ```camera-snapshot``` |
+| ```SERVICE_INITIALIZED```    |                The component has started its work.                |            ```document-reader```             |
 
 In cases of successful operation of the components, the ```data``` field will contain the following fields:
 
 ```javascript
 {
   response: { ... }, // component result
-  status: 1 // 1 for successful work and 0 for unsuccessful
+  status: 1
 }
 ```
 
@@ -217,6 +244,14 @@ In cases of unsuccessful work, the ```data``` field will contain the following f
 }
 ```
 
+Description of statuses:
+
+| Status |     Description of the status      |
+|:-------|:----------------------------------:|
+| 0      |          Process failed.           |
+| 1      | Process is completed successfully. |
+| 2      |  Process is completed by timeout.  |
+
 Table of error causes:
 
 | Reason                         |      Description of the reason      |
@@ -399,6 +434,54 @@ For camera-snapshot:
 }
 ```
 
+</td>
+<td></td>
+</tr>
+<tr>
+<td>Recognition from the camera has started.</td>
+<td>
+
+For document-reader:  
+```document-reader```
+
+For camera-snapshot:  
+```camera-snapshot```
+
+</td>
+<td>
+
+```javascript
+{
+  action: "CAMERA_PROCESS_STARTED", 
+  data: null,
+  manual: true
+}
+```
+
+</td>
+<td></td>
+</tr>
+<tr>
+<td>File processing has started.</td>
+<td>
+
+For document-reader:  
+```document-reader```
+
+For camera-snapshot:  
+```camera-snapshot```
+
+</td>
+<td>
+
+```javascript
+{
+  action: "FILE_PROCESS_STARTED", 
+  data: null,
+  manual: true
+}
+```
+
 </td>
 <td></td>
 </tr>
@@ -430,6 +513,33 @@ For camera-snapshot:
 <td></td>
 </tr>
 <tr>
+<td>The work of the component is completed by timeout.</td>
+<td>
+
+```document-reader```
+
+</td>
+<td>
+
+```javascript
+{
+  action: "PROCESS_FINISHED", 
+  data: {
+    response: { ... },
+    status: 2
+  },
+  manual: false
+}
+```
+
+</td>
+<td>
+
+This event available only in ```document-reader```.
+
+</td>
+</tr>
+<tr>
 <td>The work of the component failed.</td>
 <td>
 
@@ -508,7 +618,7 @@ component.addEventListener('document-reader', listener);
 
 | Attribute                | Info                                                                                                                                                                                                                                                                                                                                              | Data type |   Default value    |                                                                                                                                                             Values                                                                                                                                                             |
 |:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:|:------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
-| **locale**               | The language of the component interface. If empty, the language is selected from the browser settings, if it is not found, the system language is taken.                                                                                                                                                                                          |  string   |      ```en```      | ```ru```, ```en```, ```de```, ```pl```, ```it```, ```hu```, ```ch```, ```sk```, ```uk```, ```fr```, ```es```, ```pt```, ```ar```, ```nl```, ```id```, ```vi```, ```ko```, ```ms```, ```ro```, ```gr```, ```tr```, ```jp```, ```cz```, ```th```, ```hi```, ```bn```, ```he```, ```fi```, ```sv```, ```da```, ```hr```, ```no``` |
+| **locale**               | The language of the component interface. If empty, the language is selected from the browser settings, if it is not found, the system language is taken.                                                                                                                                                                                          |  string   |      ```en```      | ```ru```, ```en```, ```de```, ```pl```, ```it```, ```hu```, ```zh```, ```sk```, ```uk```, ```fr```, ```es```, ```pt```, ```ar```, ```nl```, ```id```, ```vi```, ```ko```, ```ms```, ```ro```, ```el```, ```tr```, ```ja```, ```cs```, ```th```, ```hi```, ```bn```, ```he```, ```fi```, ```sv```, ```da```, ```hr```, ```no``` |
 | **internal-scenario**    | The component document verification scenario. For more details, see the [Web components documentation](https://docs.regulaforensics.com/develop/doc-reader-sdk/web-components/getting-started#processing-scenarios).                                                                                                                              |  string   | ```MrzAndLocate``` |                                                                                                                                 ```MrzAndLocate```, ```MrzOrLocate```, ```Mrz```, ```Locate```                                                                                                                                 |
 | **multipage-processing** | Whether to allow processing of two pages in cases when the component detects an ID1-sized document. Multipage processing is not triggered for documents of other formats. If ```true```, the component asks for the second page and processes it. If ```false```, only one page/side of the document is processed regardless the document format. |  boolean  |    ```false```     |                                                                                                                                                    ```true```, ```false```                                                                                                                                                     |
 | **start-screen**         | Whether to show the start screen with two options for the document image uploading: From camera and From gallery. If ```true```, the start screen is shown. If ```false```, no start screen is shown and instead the camera of the device is turned on automatically to capture the image of the document.                                        |  boolean  |    ```false```     |                                                                                                                                                    ```true```, ```false```                                                                                                                                                     |
@@ -523,7 +633,7 @@ component.addEventListener('document-reader', listener);
 
 | Attribute         | Info                                                                                                                                                                                                                                                                                                       | Data type |  Default value  |                                                                                                                                                             Values                                                                                                                                                             |
 |:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:|:---------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
-| **locale**        | The language of the component interface. If empty, the language is selected from the browser settings, if it is not found, the system language is taken.                                                                                                                                                   |  string   |    ```en```     | ```ru```, ```en```, ```de```, ```pl```, ```it```, ```hu```, ```ch```, ```sk```, ```uk```, ```fr```, ```es```, ```pt```, ```ar```, ```nl```, ```id```, ```vi```, ```ko```, ```ms```, ```ro```, ```gr```, ```tr```, ```jp```, ```cz```, ```th```, ```hi```, ```bn```, ```he```, ```fi```, ```sv```, ```da```, ```hr```, ```no``` |
+| **locale**        | The language of the component interface. If empty, the language is selected from the browser settings, if it is not found, the system language is taken.                                                                                                                                                   |  string   |    ```en```     | ```ru```, ```en```, ```de```, ```pl```, ```it```, ```hu```, ```zh```, ```sk```, ```uk```, ```fr```, ```es```, ```pt```, ```ar```, ```nl```, ```id```, ```vi```, ```ko```, ```ms```, ```ro```, ```el```, ```tr```, ```ja```, ```cs```, ```th```, ```hi```, ```bn```, ```he```, ```fi```, ```sv```, ```da```, ```hr```, ```no``` |
 | **start-screen**  | Whether to show the start screen with two options for the document image uploading: From camera and From gallery. If ```true```, the start screen is shown. If ```false```, no start screen is shown and instead the camera of the device is turned on automatically to capture the image of the document. |  boolean  |   ```false```   |                                                                                                                                                    ```true```, ```false```                                                                                                                                                     |                                                                                                  
 | **multiple**      | Whether to allow uploading more than one file via the file system.  Can be set to ```true``` only if ```startScreen``` is ```true```.                                                                                                                                                                      |  boolean  |   ```true```    |                                                                                                                                                    ```true```, ```false```                                                                                                                                                     |
 | **camera-id**     | Ability to select a camera. You can get the device ID using [navigator.mediaDevices.enumerateDevices()](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/enumerateDevices).                                                                                                                   |  string   | ```undefined``` |                                                                                                                                                  ```camera id string value```                                                                                                                                                  |
@@ -533,15 +643,17 @@ component.addEventListener('document-reader', listener);
 
 ### Customization
 
+#### Font and colors
+
 Using CSS variables, you can change the font and the main colors of the components.
 
 | Variable           | Info                                                                                                                                                           |        Default value        |
 |:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------:|
 | **--font-family**  | The font family of all text elements. If you change the font family, make sure to adjust the fond size so the message on the start screen would fit the frame. | ```Noto Sans, sans-serif``` |
 | **--font-size**    | The font size for the text elements.                                                                                                                           |         ```16px```          |
-| **--main-color**   | Color for the graphic elements of the component. By default, the brand Regula violet is set.                                                                   |        ```#663399```        |
-| **--hover-color**  | Buttons hover color.                                                                                                                                           |        ```#7c45b4```        |
-| **--active-color** | Buttons active color.                                                                                                                                          |        ```#663399```        |
+| **--main-color**   | Color for the graphic elements of the component. By default, the brand Regula violet is set.                                                                   |        ```#bd7dff```        |
+| **--hover-color**  | Buttons hover color.                                                                                                                                           |        ```#c994ff```        |
+| **--active-color** | Buttons active color.                                                                                                                                          |        ```#bd7dff```        |
 
 For example:
 
@@ -560,6 +672,71 @@ HTML:
 <document-reader class="my-custom-style"></document-reader>
 ```
 
+#### Messages
+
+To change the standard component messages or any text, specify the language you are using (or add your own) and the label you want to change (you can see the list of available languages in the [attribute](#attributes) descriptions section, ```locale``` attribute):
+
+```javascript
+const element = document.querySelector('document-reader');
+
+element.translations = {
+   en: {
+      fromCamera: 'Use your camera',
+   },
+};
+```
+
+**Note**: to see the changes, don't forget to set the language you changed to the ```locale``` attribute.
+
+```html
+<document-reader locale="en"></document-reader>
+```
+
+List of labels used in the component:
+
+| Label                         | Default message in ```en``` locale                                                           |                   Used in                    |
+|:------------------------------|:---------------------------------------------------------------------------------------------|:--------------------------------------------:|
+| **success**                   | Success!                                                                                     | ```document-reader```, ```camera-snapshot``` |
+| **fileCorrupt**               | This file is corrupt or not supported                                                        | ```document-reader```, ```camera-snapshot``` |
+| **selectAnotherFile**         | Please select another file                                                                   | ```document-reader```, ```camera-snapshot``` |
+| **error**                     | Error!                                                                                       | ```document-reader```, ```camera-snapshot``` |
+| **somethingWentWrong**        | Something went wrong                                                                         | ```document-reader```, ```camera-snapshot``` |
+| **tryAgain**                  | Try again                                                                                    | ```document-reader```, ```camera-snapshot``` |
+| **fromCamera**                | From camera                                                                                  | ```document-reader```, ```camera-snapshot``` |
+| **fromGallery**               | From gallery                                                                                 | ```document-reader```, ```camera-snapshot``` |
+| **cameraUnavailable**         | Camera unavailable!                                                                          | ```document-reader```, ```camera-snapshot``` |
+| **preparingCamera**           | Preparing the camera...                                                                      | ```document-reader```, ```camera-snapshot``` |
+| **noCameraAvailable**         | No camera available                                                                          | ```document-reader```, ```camera-snapshot``` |
+| **incorrectCameraId**         | No camera with the specified ID found.                                                       | ```document-reader```, ```camera-snapshot``` |
+| **allowAccessToCamera**       | Allow access to the camera and reload this page to continue.                                 | ```document-reader```, ```camera-snapshot``` |
+| **cameraConnection**          | Make sure the camera is connected correctly.                                                 | ```document-reader```, ```camera-snapshot``` |
+| **checkCameraId**             | Check if the specified camera ID is correct.                                                 | ```document-reader```, ```camera-snapshot``` |
+| **scanIDInBrowser**           | Scan an ID in your browser                                                                   |            ```document-reader```             |
+| **useYourDeviceCamera**       | Use your device camera to scan a document or select a photo of the document from the gallery |            ```document-reader```             |
+| **processingFinished**        | Processing finished.                                                                         |            ```document-reader```             |
+| **largeFile**                 | This file is too large to be uploaded                                                        |            ```document-reader```             |
+| **selectSmallerFile**         | Please select a smaller file                                                                 |            ```document-reader```             |
+| **versionNotSupported**       | Your browser version is not supported                                                        |            ```document-reader```             |
+| **updateBrowser**             | Update your browser version                                                                  |            ```document-reader```             |
+| **licenseError**              | A license error has occurred                                                                 |            ```document-reader```             |
+| **licenseExpired**            | The license cannot be found or has expired                                                   |            ```document-reader```             |
+| **timeout**                   | Timeout                                                                                      |            ```document-reader```             |
+| **processing**                | Processing...                                                                                |            ```document-reader```             |
+| **preparingService**          | Preparing the service...                                                                     |            ```document-reader```             |
+| **detectingDocument**         | Detecting a document...                                                                      |            ```document-reader```             |
+| **placeDocumentIntoFrame**    | Fit the document into the frame                                                              |            ```document-reader```             |
+| **noFocus**                   | No camera focus                                                                              |            ```document-reader```             |
+| **moveCloser**                | Move closer                                                                                  |            ```document-reader```             |
+| **glaresOnDocument**          | Avoid glare on the document                                                                  |            ```document-reader```             |
+| **holdDocumentStraight**      | Hold the document straight                                                                   |            ```document-reader```             |
+| **documentProcessing**        | Document processing...                                                                       |            ```document-reader```             |
+| **flipDocument**              | Flip the document                                                                            |            ```document-reader```             |
+| **verified**                  | Verified!                                                                                    |            ```document-reader```             |
+| **positionDocumentCenter**    | Position the document in the center                                                          |            ```camera-snapshot```             |
+| **photoCapturedSuccessfully** | The photo is captured successfully.                                                          |            ```camera-snapshot```             |
+| **uploadPhoto**               | Upload a photo                                                                               |            ```camera-snapshot```             |
+| **useCameraOrGallery**        | Use your device camera or select a photo from the gallery                                    |            ```camera-snapshot```             |
+
 ## Document reader SDK
 
 You can use the document-reader SDK to create your own UI interface.
@@ -705,7 +882,7 @@ Sets the video stream settings:
 
 ```javascript
 processor.streamParam = {
-   cameraMode: 'user',      // Camera facing mode. Can be 'environment' or 'user'. By default 'user'.
+   cameraMode: 'environment',      // Camera facing mode. Can be 'environment' or 'user'. By default 'environment'.
    preferredCameraId: '',   // Selecting a camera by ID. The camera ID can be obtained using navigator.mediaDevices.enumerateDevices();. Not set by default.
    resolution: {            // Video resolution. By default 1280x720.
      width: 1280,
@@ -724,7 +901,7 @@ processor.recognizerProcessParam = {
    processParam: {
       scenario: 'MrzAndLocate',
       returnUncroppedImage: true,
-      returnPackagesForReprocess: false,
+      returnPackageForReprocess: false,
    },
 };
 ```
@@ -740,7 +917,7 @@ processor.imageProcessParam = {
    processParam: {
       scenario: 'MrzAndLocate',
       returnUncroppedImage: true,
-      returnPackagesForReprocess: false,
+      returnPackageForReprocess: false,
    },
 }
 ```