+
+
+ JPEG
+JPEG. See: https://jpeg.org/jpeg
+
+
+
+
+
+
+
+ JPEG. See: https://jpeg.org/jpeg
JPEG 2000. See: https://jpeg.org/jpeg2000
Image format.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Thrown if access to the chip data is denied either by PACE or BAC protocol.
Basic Access Control.
Password Authenticated Connection Establishment.
Access protocol for authenticating the inspection system.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Thrown if access to the chip data is denied either by PACE or BAC protocol.
Access protocol for authenticating the inspection system.
Authentication status of data and chip.
Thrown if Chip Authentication protocol fails. Secure connection was not established.
Active Authentication protocol. Used if neither PACE-CAM nor Chip Authentication protocol is supported.
Chip Authentication protocol. Used if PACE-CAM is not supported.
PACE access protocol with Chip Authentication Mapping. This protocol has top priority.
Protocol for authentication of the chip.
PACE access protocol with Chip Authentication Mapping. This protocol has top priority.
Chip Authentication protocol. Used if PACE-CAM is not supported.
Active Authentication protocol. Used if neither PACE-CAM nor Chip Authentication protocol is supported.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Chip is proved genuine.
Chip is proved not genuine.
No such protocol supported by the chip.
Authentication status of the chip.
Chip is proved genuine.
No such protocol supported by the chip.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Authentication status of the chip and protocol used for that purpose.
Protocol for authentication of the chip.
Authentication status of the chip.
The Active Authentication response (signature) is set only if explicit challenge in com.innovatrics.dot.nfc.NfcTravelDocumentReader.read operation was set by the caller and Active Authentication protocol is supported by the chip. Otherwise activeAuthenticationResponse is null.
Passive Authentication protocol.
Protocol for authentication of the data.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Data is proved genuine.
Unable to evaluate. No authority certificates provided.
Data is proved not genuine.
Authentication status of the data.
Data is proved genuine.
Unable to evaluate. No authority certificates provided.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Authentication status of the data and protocol used for that purpose.
Protocol for authentication of the data.
Authentication status of the data.
Authentication status of data and chip.
Thrown if Chip Authentication protocol fails. Secure connection was not established.
Authentication status of the chip and protocol used for that purpose.
Authentication status of the data and protocol used for that purpose.
The data group presence list.
File identifier for data group 1. Data group 1 contains the MRZ.
File identifier for data group 10. Data group 10 contains substance features.
File identifier for data group 11. Data group 11 contains additional personal details.
File identifier for data group 12. Data group 12 contains additional document details.
File identifier for data group 13. Data group 13 contains optional details.
File identifier for data group 14. Data group 14 contains security information.
File identifier for data group 15. Data group 15 contains the public key used for Active Authentication.
File identifier for data group 16. Data group 16 contains person(s) to notify.
File identifier for data group 2. Data group 2 contains face image data.
File identifier for data group 3. Data group 3 contains finger print data.
File identifier for data group 4. Data group 4 contains iris data.
File identifier for data group 5. Data group 5 contains displayed portrait.
File identifier for data group 7. Data group 7 contains displayed signature.
File identifier for data group 8. Data group 8 contains data features.
File identifier for data group 9. Data group 9 contains structure features.
The security document.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Binary representation of the Logical Data Structure / Master File according to ICAO Doc 9303, Machine Readable Travel Documents, Part 10: Logical Data Structure (LDS) for Storage of Biometrics and Other Data in the Contactless Integrated Circuit (IC) (See: Section 2: Structure of Doc 9303-10).
The data group presence list.
File identifier for data group 1. Data group 1 contains the MRZ.
File identifier for data group 10. Data group 10 contains substance features.
File identifier for data group 11. Data group 11 contains additional personal details.
File identifier for data group 12. Data group 12 contains additional document details.
File identifier for data group 13. Data group 13 contains optional details.
File identifier for data group 14. Data group 14 contains security information.
File identifier for data group 15. Data group 15 contains the public key used for Active Authentication.
File identifier for data group 16. Data group 16 contains person(s) to notify.
File identifier for data group 2. Data group 2 contains face image data.
File identifier for data group 3. Data group 3 contains finger print data.
File identifier for data group 4. Data group 4 contains iris data.
File identifier for data group 5. Data group 5 contains displayed portrait.
File identifier for data group 7. Data group 7 contains displayed signature.
File identifier for data group 8. Data group 8 contains data features.
File identifier for data group 9. Data group 9 contains structure features.
The security document.
Identifier of the LDS1 Elementary File.
More details about Elementary Files can be found in Doc 9303 Part 10: Logical Data Structure (LDS) for Storage of Biometrics and Other Data in the Contactless Integrated Circuit (IC), Chapter 4. LDS1 eMRTD Application.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Binary representation of the LDS1 Elementary File.
Binary representation of the LDS1 eMRTD Application.
Binary representation of the LDS1 Elementary File.
Binary representation of the LDS1 eMRTD Application.
Binary representation of the Logical Data Structure / Master File according to ICAO Doc 9303, Machine Readable Travel Documents, Part 10: Logical Data Structure (LDS) for Storage of Biometrics and Other Data in the Contactless Integrated Circuit (IC) (See: Section 2: Structure of Doc 9303-10).
Overriding method `provideConfiguration()` is preferred way of providing configuration.
Key for the fragment argument that contains a Configuration class.
Configuration of NFC reading for NfcTravelDocumentReaderFragment.
Random 8 bytes. If the Active Authentication challenge is set, Active Authentication protocol will be used for the authentication of the chip (if supported by the chip). Response (signature) will be returned in the TravelDocument data class. This response should be validated by the application server to verify the authenticity of the chip. In case when the Active Authentication protocol is not supported by the chip, the chip will be authenticated the same way as if the argument activeAuthenticationChallenge is not set. Default value is null.
UI NFC Travel Document Reader component.
A visual component for reading NFC Travel Documents.
Customization options:
Overwriting resources:
You can partially customize the UI by replacing the component's default resources with your own.
The following resources are expected by the component:
Drawables:
R.drawable.dot_nfc_nfc_travel_document_reader_searching
R.drawable.dot_nfc_nfc_travel_document_reader_reading (must be of type AnimatedVectorDrawable)
Strings:
R.string.dot_nfc_nfc_travel_document_reader_searching_title
R.string.dot_nfc_nfc_travel_document_reader_searching_subhead
R.string.dot_nfc_nfc_travel_document_reader_reading_title
R.string.dot_nfc_nfc_travel_document_reader_reading_subhead
Styles:
R.style.Dot_Title
R.style.Dot_Subhead
Providing a custom view:
For full customization, you can pass a custom layout via constructor or you can supply a custom view by overriding the onCreateView method.
If you choose this option, you must also override the onSearchingStarted and onReadingStarted methods to ensure your UI reflects the appropriate state during the document searching and reading processes.
Configuration of NFC reading for NfcTravelDocumentReaderFragment.
To customize the UI, you can override this method to return your own view. If you do so, must also override the onSearchingStarted and onReadingStarted methods to handle state changes appropriately in your custom view.
Subclasses must override this function to handle successful NFC document reading.
Subclasses should override this method to provide Configuration for the NFC reader.
To customize the UI, you can override this method to return your own view. If you do so, must also override the onSearchingStarted and onReadingStarted methods to handle state changes appropriately in your custom view.
Subclasses must override this function to handle successful NFC document reading.
The successfully read TravelDocument object.
Subclasses should override this method to provide Configuration for the NFC reader.
Configuration of NFC reading for NfcTravelDocumentReaderFragment.
UI NFC Travel Document Reader component.
Create X509 certificates. Note: It is the caller's responsibility to close this stream.
Set of X509 certificates.
Input stream of the certificates.
If parsing fails.
Factory for certificates.
Factory for certificates.
Parsed Data Group 12 - Additional Document Detail(s).
Parsed Data Group 11 - Additional Personal Detail(s).
Constructor.
Flat Tag Structure Parser component.
Parse bytes to a flat map of elements. Expected input value is in the following structure: ELEMENT_1_TAG, ELEMENT_1_LENGTH, ELEMENT_1_VALUE, ..., ELEMENT_N_TAG, ELEMENT_N_LENGTH, ELEMENT_N_VALUE
Map of elements, where element tags are the keys.
Byte array of the flat tag structure.
If bytes has invalid structure.
Access key to the NFC chip.
Certificates of trusted authorities. Certificates are required to successfully authenticate data in the chip.
Builder instance.
List of X509 certificates.
Use NfcTravelDocumentReader.Configuration class instead.
Configuration builder.
Certificates of trusted authorities. Certificates are required to successfully authenticate data in the chip.
The timeout only applies to ISO-DEP I/O operations on a android.nfc.Tag. Default value is 5000 ms.
The timeout only applies to ISO-DEP I/O operations on a android.nfc.Tag. Default value is 5000 ms.
Builder instance.
Milliseconds.
Use NfcTravelDocumentReader.Configuration class instead.
Configuration for the NFC Travel Document Reader component.
Create component.
Instance.
Create component.
Instance.
Component configuration.
Use create(configuration: NfcTravelDocumentReader.Configuration) instead.
Create component.
Instance.
Component configuration.
Called when access establishment process is initiated.
Certificates of trusted authorities. Certificates are required to successfully authenticate data in the chip.
The timeout only applies to ISO-DEP I/O operations on a android.nfc.Tag. Default value is 5000 ms.
Certificates of trusted authorities. Certificates are required to successfully authenticate data in the chip.
Configuration for the NFC Travel Document Reader component.
Certificates of trusted authorities. Certificates are required to successfully authenticate data in the chip.
The timeout only applies to ISO-DEP I/O operations on a android.nfc.Tag. Default value is 5000 ms.
The timeout only applies to ISO-DEP I/O operations on a android.nfc.Tag. Default value is 5000 ms.
Called when data authentication process is initiated.
Interface for handling the progress update during Elementary Files reading.
Called when progress is updated during Elementary Files reading.
Called when progress is updated during Elementary Files reading.
The LDS1 Elementary File identifier being read.
The overall reading progress in percentage.
Interface for handling a failure of the reading process.
Listeners for the NFC travel document reading process.
Called when the reading process is successfully finished.
The parsed travel document.
NFC Travel Document Reader component.
Interface for handling the start of access establishment, such as BAC/PACE method.
Configuration for the NFC Travel Document Reader component.
Interface for handling the start of data authentication.
Interface for handling the progress update during Elementary Files reading.
Interface for handling a failure of the reading process.
Listeners for the NFC travel document reading process.
Interface for handling the successful completion of the NFC travel document reading process.
Read travel document. First it executes appropriate access control method (BAC/PACE). Then it authenticates data and chip, and finally it returns travel document created from read Data Groups. This operation should be called on a background thread. Ongoing reading can be canceled by invoking the cancel method.
Read travel document. First it executes appropriate access control method (BAC/PACE). Then it authenticates data and chip, and finally it returns travel document created from read Data Groups. This operation should be called on a background thread. Ongoing reading can be canceled by invoking the cancel method.
Travel document data read from Data Groups stored on NFC chip.
Travel document NFC tag.
Travel document NFC key to establish access control. It is created from document number, date of birth and date of expiry.
Random 8 bytes. If the Active Authentication challenge is set, Active Authentication protocol will be used for the authentication of the chip (if supported by the chip). Response (signature) will be returned in the TravelDocument data class. This response should be validated by the application server to verify the authenticity of the chip. In case when the Active Authentication protocol is not supported by the chip, the chip will be authenticated the same way as if the argument activeAuthenticationChallenge is not set.
If activeAuthenticationChallenge has invalid size.
If access to the chip data is denied either by PACE or BAC protocol.
If authentication of the chip using the Chip Authentication protocol fails. Secure connection was not established.
If NFC reading fails due to an NFC tag connection failure.
If reading fails due to any other reason.
Read travel document. First it executes appropriate access control method (BAC/PACE). Then it authenticates data and chip, and finally it returns travel document created from read Data Groups. This operation should be called on a background thread. Ongoing reading can be canceled by invoking the cancel method.
Travel document NFC tag.
Travel document NFC key to establish access control. It is created from document number, date of birth and date of expiry.
Random 8 bytes. If the Active Authentication challenge is set, Active Authentication protocol will be used for the authentication of the chip (if supported by the chip). Response (signature) will be returned in the TravelDocument data class. This response should be validated by the application server to verify the authenticity of the chip. In case when the Active Authentication protocol is not supported by the chip, the chip will be authenticated the same way as if the argument activeAuthenticationChallenge is not set.
Status of the process will be reported to these listeners as well as the resulting travel document. For more information see Listeners.
If activeAuthenticationChallenge has invalid size.
If access to the chip data is denied either by PACE or BAC protocol.
If authentication of the chip using the Chip Authentication protocol fails. Secure connection was not established.
If NFC reading fails due to an NFC tag connection failure.
If reading fails due to any other reason.
Parsed Data Group 13 - Optional Details(s). Use FlatTagStructureParser in order to parse the content.
Machine Readable Travel Document (eMRTD).
Parsed Data Group 12 - Additional Document Detail(s).
Parsed Data Group 11 - Additional Personal Detail(s).
Parsed Data Group 7 - Displayed Signature or Usual Mark.
DOT NFC Library.
Parsed Data Group 2 - Encoded Identification Features - Face.
Flat Tag Structure Parser component.
Factory for Flat Tag Structure Parser component.
Parsed Data Group 1 - Machine Readable Zone Information.
Name of holder (in full).
NFC Travel Document Reader component.
Configuration for the NFC Travel Document Reader component.
Factory for NFC Travel Document Reader component.
Parsed Data Group 13 - Optional Details(s). Use FlatTagStructureParser in order to parse the content.
Machine Readable Travel Document (eMRTD).
DOT NFC API documentation.