Merge pull request #245 from BlinkID/release/5.11.0

Release/5.11.0

BlinkIDSample/build.gradle

@@ -21,7 +21,7 @@ allprojects {
 // versions of libraries that all modules require
 
 project.ext {
-    blinkIdVersion = '5.10.0'
+    blinkIdVersion = '5.11.0'
     compileSdkVersion = 30
     targetSdkVersion = 30
     appCompatVersion = '1.2.0'

README.md

@@ -66,7 +66,6 @@ Feeling ready to crack on with the integration? First make sure we support your
         * [Passport recognizer](#passportRecognizer)
         * [Visa recognizer](#visaRecognizer)
         * [ID barcode recognizer](#idBarcodeRecognizer)
-        * [AAMVA standard combined recognizer (USA, Canada, Nigeria)](#us_dl_combined_recognizer)
         * [Document face recognizer](#documentFaceRecognizer)
 * [Embedding _BlinkID_ inside another SDK](#embedAAR)
 * [Processor architecture considerations](#archConsider)
@@ -114,7 +113,7 @@ Add _BlinkID_ as a dependency and make sure `transitive` is set to true
 
 ```
 dependencies {
-    implementation('com.microblink:blinkid:5.10.0@aar') {
+    implementation('com.microblink:blinkid:5.11.0@aar') {
         transitive = true
     }
 }
@@ -126,7 +125,7 @@ Android studio 3.0 should automatically import javadoc from maven dependency. If
 
 1. In Android Studio project sidebar, ensure [project view is enabled](https://developer.android.com/sdk/installing/studio-androidview.html)
 2. Expand `External Libraries` entry (usually this is the last entry in project view)
-3. Locate `blinkid-5.10.0` entry, right click on it and select `Library Properties...`
+3. Locate `blinkid-5.11.0` entry, right click on it and select `Library Properties...`
 4. A `Library Properties` pop-up window will appear
 5. Click the second `+` button in bottom left corner of the window (the one that contains `+` with little globe)
 6. Window for defining documentation URL will appear
@@ -890,13 +889,6 @@ The [`IdBarcodeRecognizer`](https://blinkid.github.io/blinkid-android/com/microb
 
 You can find information about usage context at the beginning of [this section](#blinkid_recognizers).
 
-### <a name="us_dl_combined_recognizer"></a> AAMVA standard combined recognizer (USA, Canada, Nigeria)
-The [`UsdlCombinedRecognizer`](https://blinkid.github.io/blinkid-android/com/microblink/entities/recognizers/blinkid/usdl/UsdlCombinedRecognizer.html) first scans the front side of the document to obtain the full document image and face image. It then scans PDF417 barcode from the back side of AAMVA standard documents. This includes USA ID cards and driver’s licence, Canadian ID cards and driving licence, and Nigerian driving licence.
-
-Internally, it uses [DocumentFaceRecognizer](#documentFaceRecognizer) for obtaining full document image and face image as the first step and then [UsdlRecognizer](#us_dl_recognizer) for scanning the PDF417 barcode.
-
-You can find information about usage context at the beginning of [this section](#blinkid_recognizers).
-
 ### <a name="documentFaceRecognizer"></a> Document face recognizer
 The [`DocumentFaceRecognizer`](https://blinkid.github.io/blinkid-android/com/microblink/entities/recognizers/blinkid/documentface/DocumentFaceRecognizer.html) is a special type of recognizer that only returns face image and full document image of the scanned document. It does not extract document fields like first name, last name, etc. This generic recognizer can be used to obtain document images in cases when specific support for some document type is not available.
 

Release notes.md

@@ -1,5 +1,165 @@
 # Release notes
 
+## 5.11.0
+
+### Newly supported identity documents:
+
+We’ve added 98 new documents:
+
+#### Europe
+- Albania - Driver Card (front only)
+- Albania - Professional Driver License (front only)
+- Belarus - Driver License (front only, beta)
+- Belgium - Minors ID (beta)
+- Czechia - Residence Permit
+- Finland - Alien ID
+- Finland - Residence Permit (beta)
+- Georgia - Driver License (front only)
+- Greece - Residence Permit
+- Ireland - Passport Card (beta)
+- Ireland - Public Services Card (beta)
+- Kosovo - Driver License (front only, beta)
+- Latvia - Alien ID
+- Luxembourg - ID Card
+- Moldova - ID Card (beta)
+- North Macedonia - Driver License (front only)
+- North Macedonia - ID Card
+- Poland - Passport (beta)
+- Slovenia - Residence Permit (beta)
+- Spain - Alien ID
+- UK - Passport (beta)
+
+#### Middle East and Africa 
+- Algeria - Driver License
+- Burkina Faso - ID Card (front only)
+- Cameroon - ID Card (beta)
+- Democratic Republic Of The Congo - Driver License (front only, beta)
+- Egypt - Driver License (beta)
+- Ghana - ID Card (beta)
+- Iraq - ID Card (beta)
+- Ivory Coast - Driver License (front only, beta)
+- Ivory Coast - ID Card
+- Lebanon - ID Card (beta)
+- Morocco - Driver License
+- Mozambique - Driver License (front only, beta)
+- Oman - Driver License (beta)
+- Rwanda - ID Card (front only)
+- Senegal - ID Card
+- Tanzania - Driver License (front only, beta)
+- Tunisia - Driver License (front only)
+- Uganda - Driver License (front only, beta)
+
+#### Latin America & the Caribbean
+- Argentina - Alien ID (beta)
+- Bahamas - ID Card (front only, beta)
+- Bolivia - Minors ID (beta)
+- Jamaica - Driver License
+- Mexico - Residence Permit (beta)
+- Mexico - Chiapas - Driver License (front only)
+- Mexico - Coahuila - Driver License (beta)
+- Mexico - Durango - Driver License(front only, beta)
+- Mexico - Guerrero-cocula - Driver License (beta)
+- Mexico - Guerrero-juchitan - Driver License (beta)
+- Mexico - Guerrero-tepecoacuilco - Driver License (front only, beta)
+- Mexico - Guerrero-tlacoapa - Driver License (front only, beta)
+- Mexico - Hidalgo - Driver License
+- Mexico - Mexico - Driver License (beta)
+- Mexico - Morelos - Driver License (front only)
+- Mexico - Oaxaca - Driver License
+- Mexico - Puebla - Driver License (front only, beta)
+- Mexico - San Luis Potosi - Driver License (front only)
+- Mexico - Sinaloa - Driver License (front only, beta)
+- Mexico - Sonora - Driver License (beta)
+- Mexico - Tabasco - Driver License (beta)
+- Mexico - Yucatan - Driver License (beta)
+- Mexico - Zacatecas - Driver License (beta)
+- Panama - Temporary Residence Permit (beta)
+- Peru - Minors ID (beta)
+- Trinidad And Tobago - Driver License (front only, beta)
+- Trinidad And Tobago - ID Card
+
+#### Oceania
+- Australia - South Australia - Proof Of Age Card (front only, beta)
+
+#### Asia
+- Armenia - ID Card
+- Bangladesh - Driver License (beta)
+- Cambodia - Driver License (front only, beta)
+- India - Gujarat - Driving Licence (front only, beta)
+- India - Karnataka - Driving Licence (front only, beta)
+- India - Kerala - Driving Licence (beta)
+- India - Madhya Pradesh - Driving Licence (front only, beta)
+- India - Maharashtra - Driving Licence (front only, beta)
+- India - Punjab - Driving Licence (front only, beta)
+- India - Tamil Nadu - Driving Licence (beta)
+- Kyrgyzstan - ID Card
+- Malaysia - Mypolis (beta)
+- Malaysia - Refugee ID (front only)
+- Myanmar - Driver License (beta)
+- Pakistan - Punjab - Driving Licence (front only, beta)
+- Sri Lanka - Driving Licence (front only)
+- Thailand - Alien ID (front only)
+- Thailand - Driver License (beta)
+- Uzbekistan - Driver License (front only, beta)
+
+#### Northern America
+- Canada - Tribal ID (beta)
+- Canada - Nova Scotia - ID Card (beta)
+- Canada - Saskatchewan - ID Card (beta)
+- USA - Border Crossing Card (front only)
+- USA - Global Entry Card (beta)
+- USA - Nexus Card (beta)
+- USA - Veteran ID (front only)
+- USA - Work Permit
+- USA - Mississippi - ID Card (beta)
+- USA - Montana - ID Card
+- USA - New Mexico - ID Card (beta)
+- USA - Wisconsin - ID Card (beta)
+
+#### Back side support added:
+- Hungary - Residence Permit
+- Luxembourg - Residence Permit (no longer beta)
+- Mauritius - ID Card
+- Colombia - Alien ID (no longer beta)
+- Mexico - Baja California - Driver License
+- Mexico - Chihuahua - Driver License
+- Mexico - Guanajuato - Driver License
+- Mexico - Michoacan - Driver License
+- Malaysia - MyKid
+- Malaysia - MyPR
+
+#### No longer beta:
+- Albania - Passport
+- Malta - Residence Permit
+- Switzerland - Residence Permit
+- Bolivia - Driver License
+- Chile - Passport
+- El Salvador - ID Card
+- Peru - ID Card
+- Singapore - S Pass (front only)
+
+### Changes to the BlinkId(Combined)Recognizer
+- You can now retrieve an image of the document owner along with cropped images of the document itself whenever you’re scanning an AAMVA-compliant ID: 
+
+	- Using `BarcodeId` as a `RecognitionMode` lets you scan US driver licenses and IDs that BlinkID can’t read from the Visual Inspection Zone (VIZ) alone. Use it to extract:
+		- A face image from the front side
+		- Barcode data from the back side
+		- Cropped document images of both sides
+	- You can disable this `RecognitionMode` by setting `enableBarcodeId` to `false` in the `RecognitionModeFilter`.
+- We've improved data extraction through the MRZ:
+	- We now allow standard M/F values for gender on Mexican documents (along with localized H/M values)
+- We're now converting dates to the Gregorian calendar for:
+	- Taiwan documents with Republic of China (ROC) calendar dates
+	- Saudi documents with Islamic calendar dates
+- We're now auto-filling all ‘partial’ dates found on identity documents (showing year or month-year only):
+	- Date of issue will be converted to the first day of the (first) month
+		- E.g. '1999' will be converted to '01.01.1999.'
+		- E.g. '03.1999.' will be converted to '01.03.1999.'
+	- Date of expiry will be converted to the last day of the (last) month
+		- E.g. '1999' will be converted to '31.12.1999.'
+		- E.g. '03.1999.' will be converted to '31.03.1999.'
+
+
 ## 5.10.0
 
 ### Improvements
@@ -47,6 +207,7 @@
 
 ### Minor API changes
 
+- We've replaced `Using time-limited license!` warning with `Using trial license!` warning. The warning message is displayed when using a trial license key.
 - We’ve renamed `MrtdDocumentType.MRTD_TYPE_IDENITY_CARD` enum member to `MrtdDocumentType.MRTD_TYPE_IDENTITY_CARD`.
 
 ### Fixes:

builtFromCommit.txt

@@ -1 +1 @@
-Built from commit 657d7b6e30c57f1c07853a57ac0e688ef15da474
+Built from commit 907fe49f6e97a0bcd6b006327e9cdec811eba397

docs/com/microblink/entities/recognizers/blinkid/generic/BlinkIdCombinedRecognizer.html

@@ -735,7 +735,7 @@ <h4>setScanCroppedDocumentImage</h4>
 <pre>public&nbsp;void&nbsp;setScanCroppedDocumentImage(boolean&nbsp;scanCroppedDocumentImage)</pre>
 <div class="block">Configure the recognizer to only work on already cropped and dewarped images.
  This only works for still images - video feeds will ignore this setting.
- By default, this is set to 'true'.</div>
+ By default, this is set to 'false'.</div>
 </li>
 </ul>
 <a name="shouldScanCroppedDocumentImage--">
@@ -747,7 +747,7 @@ <h4>shouldScanCroppedDocumentImage</h4>
 <pre>public&nbsp;boolean&nbsp;shouldScanCroppedDocumentImage()</pre>
 <div class="block">Configure the recognizer to only work on already cropped and dewarped images.
  This only works for still images - video feeds will ignore this setting.
- By default, this is set to 'true'.</div>
+ By default, this is set to 'false'.</div>
 </li>
 </ul>
 <a name="setEncodeFullDocumentImage-boolean-">
@@ -1314,7 +1314,7 @@ <h4>setRecognitionModeFilter</h4>
 <pre>public&nbsp;void&nbsp;setRecognitionModeFilter(@NonNull
                                      <a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionModeFilter.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionModeFilter</a>&nbsp;recognitionModeFilter)</pre>
 <div class="block">Enable or disable recognition of specific document groups supported by the current license.
- By default, this is set to '[true, true, true, true, true]'.</div>
+ By default, this is set to '[true, true, true, true, true, true]'.</div>
 </li>
 </ul>
 <a name="getRecognitionModeFilter--">
@@ -1326,7 +1326,7 @@ <h4>getRecognitionModeFilter</h4>
 <pre>@NonNull
 public&nbsp;<a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionModeFilter.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionModeFilter</a>&nbsp;getRecognitionModeFilter()</pre>
 <div class="block">Returns currently set recognition mode filter.
- By default, this is set to '[true, true, true, true, true]'.</div>
+ By default, this is set to '[true, true, true, true, true, true]'.</div>
 </li>
 </ul>
 <a name="setDewarpedImageCallback-com.microblink.entities.recognizers.blinkid.generic.DewarpedImageCallback-">

docs/com/microblink/entities/recognizers/blinkid/generic/BlinkIdRecognizer.html

@@ -693,7 +693,7 @@ <h4>setScanCroppedDocumentImage</h4>
 <pre>public&nbsp;void&nbsp;setScanCroppedDocumentImage(boolean&nbsp;scanCroppedDocumentImage)</pre>
 <div class="block">Configure the recognizer to only work on already cropped and dewarped images.
  This only works for still images - video feeds will ignore this setting.
- By default, this is set to 'true'.</div>
+ By default, this is set to 'false'.</div>
 </li>
 </ul>
 <a name="shouldScanCroppedDocumentImage--">
@@ -705,7 +705,7 @@ <h4>shouldScanCroppedDocumentImage</h4>
 <pre>public&nbsp;boolean&nbsp;shouldScanCroppedDocumentImage()</pre>
 <div class="block">Configure the recognizer to only work on already cropped and dewarped images.
  This only works for still images - video feeds will ignore this setting.
- By default, this is set to 'true'.</div>
+ By default, this is set to 'false'.</div>
 </li>
 </ul>
 <a name="setEncodeFullDocumentImage-boolean-">
@@ -1214,7 +1214,7 @@ <h4>setRecognitionModeFilter</h4>
 <pre>public&nbsp;void&nbsp;setRecognitionModeFilter(@NonNull
                                      <a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionModeFilter.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionModeFilter</a>&nbsp;recognitionModeFilter)</pre>
 <div class="block">Enable or disable recognition of specific document groups supported by the current license.
- By default, this is set to '[true, true, true, true, true]'.</div>
+ By default, this is set to '[true, true, true, true, true, true]'.</div>
 </li>
 </ul>
 <a name="getRecognitionModeFilter--">
@@ -1226,7 +1226,7 @@ <h4>getRecognitionModeFilter</h4>
 <pre>@NonNull
 public&nbsp;<a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionModeFilter.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionModeFilter</a>&nbsp;getRecognitionModeFilter()</pre>
 <div class="block">Returns currently set recognition mode filter.
- By default, this is set to '[true, true, true, true, true]'.</div>
+ By default, this is set to '[true, true, true, true, true, true]'.</div>
 </li>
 </ul>
 <a name="setDewarpedImageCallback-com.microblink.entities.recognizers.blinkid.generic.DewarpedImageCallback-">

docs/com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html

@@ -142,35 +142,41 @@ <h3>Field Summary</h3>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionMode</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html#BarcodeId">BarcodeId</a></span></code>
+<div class="block">Recognition of barcode document.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static <a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionMode</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html#FullRecognition">FullRecognition</a></span></code>
 <div class="block">Detailed document recognition.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionMode</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html#MrzId">MrzId</a></span></code>
 <div class="block">Recognition of mrz document (does not include visa and passport)</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionMode</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html#MrzPassport">MrzPassport</a></span></code>
 <div class="block">Recognition of passport mrz.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionMode</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html#MrzVisa">MrzVisa</a></span></code>
 <div class="block">Recognition of visa mrz.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionMode</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html#None">None</a></span></code>
 <div class="block">No recognition performed.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionMode</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html#PhotoId">PhotoId</a></span></code>
 <div class="block">Recognition of documents that have face photo on the front.</div>
@@ -281,13 +287,23 @@ <h4>PhotoId</h4>
 <a name="FullRecognition">
 <!--   -->
 </a>
-<ul class="blockListLast">
+<ul class="blockList">
 <li class="blockList">
 <h4>FullRecognition</h4>
 <pre>public static final&nbsp;<a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionMode</a> FullRecognition</pre>
 <div class="block">Detailed document recognition.</div>
 </li>
 </ul>
+<a name="BarcodeId">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>BarcodeId</h4>
+<pre>public static final&nbsp;<a href="../../../../../../com/microblink/entities/recognizers/blinkid/generic/RecognitionMode.html" title="class in com.microblink.entities.recognizers.blinkid.generic">RecognitionMode</a> BarcodeId</pre>
+<div class="block">Recognition of barcode document.</div>
+</li>
+</ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->