ID
The Anyline ID Plugin provides the functionality to scan passports and other documents holding a Machine Readable Zone (MRZ) as well as a list of driver’s licenses, ID cards and health insurance cards. The details of the supported documents are described in the configuration info below.
Note
The ID plugin itself does not provide the functionality to scan PDF417 barcodes. However, you can add simultaneous barcode scanning to your ID implementation to have both functionalities within the same scan mode.
Configurations
The idConfig determines which of the ID use cases you want to scan.
Any of the different use cases can be started from the ID Plugin by setting the respective idConfig.
MRZ
By setting an mrzConfig, you can scan ID documents containing a Machine Readable Zone (MRZ).
For details about how to set the specific config parameters and how to implement the MRZ mode, see MRZ.
Universal ID
New in version 22.
By setting a universalIdConfig, you can scan different types of ID documents with one configuration using the Universal ID mode.
New in version 34.
Starting with Anyline 34, you can use the universalIdConfig to enable scanning different alphabets/scripts like Latin, Arabic or Cyrillic.
For details about supported documents, how to set the specific config parameters and how to implement the Universal ID mode see, Universal ID.
Japanese Landing Permission
New in version 32.
By setting a japaneseLandingPermissionConfig, you can scan Japanese Landing Permission stickers.
For more information about the mode, visit the page of the Japanese Landing Permission.
Vehicle Registration Certificate
New in version 42.
By setting a vehicleRegistrationCertificateConfig, you can scan the German Vehicle Registration Certificate document.
For more information about the mode, visit the page of the Vehicle Registration Certificate.
Field Scan Options
New in version 10.
The scannable information of the ID Plugin contains various data fields. Starting with Anyline 10, you can specify which parts of the scannable information you want to scan.
For each of the configurable data fields, you can select one of the following options:
Special Cases:
Depending on the use case and document type, there can be exceptions to the definitions below for individual fields. Please refer to the respective use cases pages listed below for details.
fieldScanOption.Mandatory
If a data field is set to mandatory, it will always be scanned and added to the result. If the data field is missing in the ID document or invalid, no result will be returned.
Condition:
A data field will only be treated as mandatory if it is within the scope of the ID Scanner, which can depend on the document type! If for certain document types, a field does not exist or is not supported by our SDK, a mandatory value will be reset internally.
fieldScanOption.Optional
If a data field is set to optional, it can be scanned and added to the result. If the field is missing in the ID document or invalid, but all mandatory fields are successfully scanned, the result will be returned without the optional data field. If the optional field is found and valid and all mandatory fields are found and valid as well, the optional field will also be returned in the result.
fieldScanOption.Disabled
If a data field is set to disabled, it will never be scanned and added to the result. This can increase the scan speed for enabled data fields.
fieldScanOption.Default
If a data field is set to default or not set at all, one of the three values above will be selected automatically according to the default configuration in our SDK. The default values for each data field are listed in the use case pages.
In the respective idConfig, you can set corresponding fieldScanOptions. For each of the ID configurations, different data fields can be configured. For details, see:
Confidence and Field Confidences
New in version 11.
Every Anyline scan result includes a confidence value (between 0 and 100) that indicates how confident our OCR scanner is that the result it returns is correct. Starting with Anyline 11, the ID Plugin additionally returns a field confidence for every scanned data field. The overall confidence of the result is equal to the lowest field confidence.
In the respective idConfig, you can specify how confident the OCR scanner has to be to accept a result. If you want to specify a minimum confidence for one or more particular data field(s), you can set corresponding minimum fieldConfidences. Additionally, you can set a general minConfidence which will be used for all data fields for which no minimum field confidence is set.
A field will only be present in the result if its field confidence is sufficiently high. If the corresponding fieldScanOption is set to fieldScanOption.Mandatory, no result will be returned if its field confidence is too low. If the corresponding scan option is set to fieldScanOption.Optional, a result will be returned, but it will not contain the field with the low field confidence.
Example 1:
If you set the generalminConfidenceto 40 and the minimumfieldConfidencefor the document number to 60, the date of expiry to optional and all other fields are set to mandatory, the following will happen: A result will only be returned if the field confidence for the document number is 60 or higher and for all other fields 40 or higher. If the field confidence for the date of expiry is lower than 40, a result will still be returned, but the date of expiry and its confidence will be missing in the returned scan result.
Example 2:
If you don’t set anything, a default value will be used for the generalminConfidencewhich depends on the respectiveidConfig(MRZ or Universal ID). This value will also be used for all field confidences.
Warning:
Setting aminConfidenceand/or minimumfieldConfidencescan affect the accuracy and performance of the ID scanner: High confidence values can lead to reduced scanning speed and do not guarantee correct results. Low values can reduce the accuracy of the result.
For each of the ID configurations, the minConfidence has different default values and minimum fieldConfidences can be set for different data fields. For details, see:
Additional Features
NFC Reader
The MRZ capability of the Anyline ID Product can also be used together with our NFC Reader API to read additional information from passports.