read

open fun read(isoDep: IsoDep, documentNumber: String, dateOfBirth: String, dateOfExpiry: String): EmrtdResult

Read an eMRTD.

Return

EmrtdResult holding eMRTD data

Parameters

isoDep

IsoDep of an ISO7816 Tag with the eMRTD applet.

documentNumber

document number from the MRZ.

dateOfBirth

date of birth from the MRZ (Format: yyMMDD)

dateOfExpiry

date of expiry from the MRZ (Format: yyMMDD)

Throws

eMRTD Session was not successful. Query getMessage for details.

Access Control failed. Ensure that the provided AccessKey values (document number, date of birth, date ofexpiry) are correct.

the connection to NFC tag was lost. Please hold thephone and the document steady and try again.


open fun read(isoDep: IsoDep, documentNumber: String, dateOfBirth: String, dateOfExpiry: String, filesToRead: DataGroupSet): EmrtdResult

Read the selected data groups of an eMRTD.

Reading fewer files is faster, because DG2 holds the face image and takes most of the reading time. See DataGroupSet for the available selections.

Return

EmrtdResult holding eMRTD data

Parameters

isoDep

IsoDep of an ISO7816 Tag with the eMRTD applet.

documentNumber

document number from the MRZ.

dateOfBirth

date of birth from the MRZ (Format: yyMMDD)

dateOfExpiry

date of expiry from the MRZ (Format: yyMMDD)

filesToRead

the data groups to read, e.g. MINIMAL forthe MRZ only or MINIMAL_KYC for MRZ plusface image. Data groups the document does not contain areskipped; DG14 and DG15 are read whenever the chip offers them,because Chip and Active Authentication need them.

Throws

eMRTD Session was not successful. Query getMessage for details.

Access Control failed. Ensure that the provided AccessKey values (document number, date of birth, date ofexpiry) are correct.

the connection to NFC tag was lost. Please hold thephone and the document steady and try again.


open fun read(isoDep: IsoDep, can: String): EmrtdResult

Read an eMRTD.

Return

EmrtdResult holding eMRTD data

Parameters

isoDep

IsoDep of an ISO7816 Tag with the eMRTD applet.

can

CAN, a 6 digit number, printed on the front of the document.

Throws

eMRTD Session was not successful. Query getMessage for details.

Access Control failed. Ensure that the provided AccessKey values (document number, date of birth, date ofexpiry) are correct.

the connection to NFC tag was lost. Please hold thephone and the document steady and try again.


open fun read(isoDep: IsoDep, can: String, filesToRead: DataGroupSet): EmrtdResult

Read the selected data groups of an eMRTD.

Reading fewer files is faster, because DG2 holds the face image and takes most of the reading time. See DataGroupSet for the available selections.

Return

EmrtdResult holding eMRTD data

Parameters

isoDep

IsoDep of an ISO7816 Tag with the eMRTD applet.

can

CAN, a 6 digit number, printed on the front of the document.

filesToRead

the data groups to read, e.g. MINIMAL for theMRZ only or MINIMAL_KYC for MRZ plus face image.Data groups the document does not contain are skipped; DG14 and DG15are read whenever the chip offers them, because Chip and ActiveAuthentication need them.

Throws

eMRTD Session was not successful. Query getMessage for details.

Access Control failed. Ensure that the provided AccessKey values (document number, date of birth, date ofexpiry) are correct.

the connection to NFC tag was lost. Please hold thephone and the document steady and try again.