All pages
Powered by GitBook
1 of 3

Loading...

Loading...

Loading...

0x1202 - Age Verification for ISO 18013-5

The host uses this command to start Age Verification through mobile document transaction.

The sequence of events for transactions with device (mDOC Reader) enabled is roughly as follows.

1

Command 0x1202 is a subset of Command 0x1201. It only allows a request item, Age over 18, 21 or 25. It only supports ISO 18013-5 specification. The rest of the features are the same.

2

The device sends a response in the format below, and waits for the mDOC Holder (Apple, Android or other phones) to present a Data Engagement method, either QR Code or NFC. The data exchanged during the Data Engagement phase will be used to generate multiple keys for the encryption/decryption of mDOC messages. The ephemeral key generation algorith is defined in ISO-IEC-18013-5.

3

After the mDOC Holder presents data engagement method, the device sends Notification 0x0101 - Transaction Information Update to report the Data Engagement status. If Data Engagement phase has completed successfully, then go to the next step to handle Data Retrieval phase. Else, exit with failure.

4

The device will connect to the mDOC holder through BLE connection. The device will build the β€œmdoc request” message based on the settings of the command string below. The mDOC Holder will send back the β€œmdoc response" to the device. The device will decode the CBOR encoded response message.

5

The device will authenticate the β€œmdoc response" message with a pre-loaded certificate. The device will verify the SHA-256 hash of all the response items to validate the Data integrity. If the security validation has completed successfully, the device will send the results to the host through Notification 0x0101. Otherwise, the device will send a failure message through Notification 0x0101.

6

Host may set up the A4 TLVs to enable/disable/select the proper Audio Cue during operation.

This command requires AC3 firmware or later. During the introductory preview, it runs without a subscription. After the preview ends, it runs only when the device holds an active mDoc subscription (1.2.9.1.1.1 - Mobile Document Subscription). Without one, the device does not start the transaction. See 1.2.9.nnn - Enable Mobile Document Features for details.

Because this command requests only the age-over element, the host can complete an age check without receiving the holder's name, birth date, or other identifying data.

Code

Description

AA 00

// marker

81 04 01 05 12 02

// command 0x1202

84 32 12 02

// command payload

82 01 1E

// timeout: 30 seconds

85 01 00

// Output Data security is disabled

Tag

Len

Value / Description

Typ

Req

Default

82

01

This parameter defines how long the device waits for the completion of this command..

  • 0x00 = No timeout

  • 0x01 to 0xFF = 1 to 255 seconds

B

R

83

01

This parameter defines the options of age verification.

  • 1=18, 2=21, 3=25 years old.

  • 00, 04-FF: Reserved

Codes for Command 0x1201 - Read Mobile Document

Subscription Requirement

Request Data for Command 0x1201 - Read Mobile Document

87 01 00

// Do not retain the received data

A3 06

// reader options

83 01 01

// NFC reader is enabled

85 01 01

// BCR reader is enabled

A4 1D

// audio cue option

81 01 02

// command mode

82 04 03B80040

// Start engagement profile

83 08 01B8009603700096

// Finish engagement profile

84 08 0370009600C80096

// BLE transfer complete profile

B

R

85

01

It defines the security of the Data Container. If security is enabled, Data Container will be Encrypted and MACed.

  • 0x00, security is disabled.

  • 0x01, security is enabled.

B

R

87

01

It defines the reader shall or shall not retain the received data elements.

  • 0x00, Shall not retain the data.

  • 0x01, Shall retain the data.

B

R

A3

06

Device Engagement Phase Options

The parameters inside this TLV data object allow the host to enable and disable the various interfaces to start engagement.

T

R

/83

01

NFC Mode

  • 0x00 = Disabled

  • 0x01 = Enabled

B

R

/85

01

QR Code Mode

  • 0x00 = Disabled

  • 0x01 = Enabled

  • 0x02 = Onboard BCR Disabled, BCR data from Tag 86

B

R

86

var

BCR data (optional / required if Tag 85 is 02)

B

0/R

A4

var

Audio Cue option

T

R

/81

01

Device Audio Mode

  • 0x00 = disabled

  • 0x01 = auto

  • 0x02 = command, the following 4 TLVs are required if the value is 0x02

If set to 0x01 auto mode. The tone profiles are:

03B80040 // Start engagement

01B8009603700096 // Finish engagement

01B8009603700096 //BLE/mDoc Transfer complete

012C009600960096 // mDL transaction error

B

R

/82

04

Start engagement profile

4 bytes data parameter for each tone in the sequence

Byte0-Byte1 – Frequency in units of 1 Hz

  • 0x0000..0x0031 (< 50 Hz, Silent)

  • 0x0032 - Min (50 Hz)

Value / Description Typ Req

  • 0x0FA0 - Max (4000 Hz)

  • 0x0FA1..0xFFFF (> 4000 Hz, Error)

Byte 2-Byte3 – Duration of tone in units of 1 millisecond

  • 0x0001 – Min (1 ms)

  • 0xFFFF – Max (65535 ms)

B

O/R

/83

08

Finish engagement profile

2 set of data parameter for each tone as above

B

O/R

/84

08

BLE transfer complete profile

2 set of data parameter for each tone as above

B

O/R

/85

08

mDL transaction error 2 set of data parameter for each tone as above

B

O/R

0x1201 - Read Mobile Document

The host uses this command to start a mobile document transaction.

The sequence of events for transactions with device (mDOC Reader) enabled is roughly as follows.

1

The host composes a command request in the format below, and sends it to the device. It may cancel the transaction in process by calling Command 0x1008 - Cancel Transaction.

2

The device sends a response in the format below, and waits for the mDOC Holder (Apple, Android or other phones) to present a Data Engagement method, either QR Code or NFC. The data exchanged during the Data Engagement phase will be used to generate multiple keys for the encryption/decryption of mDOC messages. The ephemeral key generation algorith is defined in ISO-IEC-18013-5.

3

After the mDOC Holder presents data engagement method, the device sends Notification 0x0101 - Transaction Information Update to report the Data Engagement status. If Data Engagement phase has completed successfully, then go to the next step to handle Data Retrieval phase. Else, exit with failure.

4

The device will connect to the mDOC holder through BLE connection. The device will build the β€œmdoc request” message based on the settings of the command string below. The mDOC Holder will send back the β€œmdoc response" to the device. The device will decode the CBOR encoded response message.

5

The device will authenticate the β€œmdoc response" message with a pre-loaded certificate. The device will verify the SHA-256 hash of all the response items to validate the Data integrity. If the security validation has completed successfully, the device will send the results to the host through Notification 0x0101. Otherwise, the device will send a failure message through Notification 0x0101.

6

Host may set up the A4 TLVs to enable/disable/select the proper Audio Cue during operation.

This command requires AC3 firmware or later. During the introductory preview, it runs without a subscription. After the preview ends, it runs only when the device holds an active mDoc subscription 1.2.9.1.1.1 - Mobile Document Subscription. Without one, the device does not start the transaction. See 1.2.9.nnn - Enable Mobile Document Features for details.

Code

Description

AA 00

// MMS Header

81 04 01 05 12 01

// command 0x1201

84 3F 12 01

// command payload

81 01 30

// timeout: 30 seconds

83 0C

// select bit mapped request items

Tag

Len

Value / Description

Typ

Req

Default

81

01

This parameter select the namespace to operate.

Β· 0x00 = ISO 18013-5 and AAMVA.

Β· 0x01 = ISO 23220-4.

Β· 0x02 to 0xFF = Reserved.

B

R

82

01

Note: If the subscription is disabled, the device return a failure response with status code 0x1E.

Codes for Command 0x1201 - Read Mobile Document

Subscription Requirement

Request Data for Command 0x1201- Read Mobile Document

00 00 00 00 00 00 00 CD

// ISO, Bit 0, 2, 3, 6, 7 are enabled

00 00 08 00

// AAMVA, Bit 11 is enabled

85 01 00

// Output Data security is disabled

87 01 00

// Do not retain the received data

A3 03

// reader options

83 01 01

// BCR reader is enabled

A4 27

// audio cue options

81 01 02

// command mode

82 04 03B80040

// Start engagement profile

83 08 01B8009603700096

// Finish engagement

84 08 01B8009603700096

// BLE Transfer complete/mDoc complete

85 08 012C009600960096

// mDL transaction error

This parameter defines how long the device waits for the completion of this command.

Β· 0x00 = No timeout

Β· 0x01 to 0xFF = 1 to 255 seconds

B

R

83

0C

This parameter defines the 96 bits (12 bytes) of bit mapped request items. (Note: At least 1 valid bit shall be enabled, else return error status.)

If the namespace of Tag 0x81 is 0x00, then V[0-B] bytes are:

Β· V[0] – V[3], Bit 63 – 32 for ISO 18013-5, Byte 7 – 4.

Β· V[4] – V[7], Bit 31 – 00 for ISO 18013-5, Byte 3 – 0.

Β· V[8] – V[B], Bit 31 – 00 for AAMVA. Byte 3 – 0.

If the namespace of Tag 0x81 is 0x01, then V[0-B] bytes are:

Β· V[0] – V[3], Bit 31 – 00 for ISO 23220-4, Byte 3 – 0.

Β· V[4] – V[B], 8 bytes are Reserved.

B

R

85

01

It defines the security of the Data Container. If security is enabled, Data Container will be Encrypted and MACed.

Β· 0x00, security is disabled.

Β· 0x01, security is enabled.

B

R

87

01

It defines the reader shall or shall not retain the received data elements. β€’ 0x00, Shall not retain the data. β€’ 0x01, Shall retain the data

B

R

A3

06

Device Engagement Phase Options

The parameters inside this TLV data object allow the host to enable and disable the various interfaces to start engagement.

T

R

/83

01

NFC Mode

Β· 0x00 = Disabled

Β· 0x01 = Enabled

B

R

/85

01

QR Code Mode

Β· 0x00 = Disabled

Β· 0x01 = Enabled

Β· 0x02 = Onboard BCR Disabled, BCR data from Tag 86

B

R

86

var

BCR data (optional / required if Tag 85 is 02)

B

O/R

A4

var

Audio Cue Options

T

R

/81

01

Device Audio Mode

0x00 = disabled

0x01 = auto

0x02 = command, the following 4 TLVs are required if the

value is 0x02

If set to 0x01 auto mode. The tone profiles are:

03B80040 // Start engagement

01B8009603700096 // Finish engagement

01B8009603700096 //BLE/mDoc Transfer complete

012C009600960096 // mDL transaction error

B

R

/82

04

Start engagement profile

4 bytes data parameter for each tone in the sequence

Byte0-Byte1 – Frequency in units of 1 Hz Β· 0x0000..0x0031 (< 50 Hz, Silent) Β· 0x0032 - Min (50 Hz)

Value / Description Typ Req Β· 0x0FA0 - Max (4000 Hz) Β· 0x0FA1..0xFFFF (> 4000 Hz, Error)

Byte 2-Byte3 – Duration of tone in units of 1 millisecond Β· 0x0001 – Min (1 ms) Β· 0xFFFF – Max (65535 ms)

B

O/R

/83

08

Finish engagement profile

2 set of data parameter for each tone as above

B

O/R

/84

08

BLE transfer complete profile

2 set of data parameter for each tone as above

B

O/R

/85

08

mDL transaction error

2 set of data parameter for each tone as above

B

O/R

0x12nn - Read Mobile Document

This section of the DynaFamily Programmer's Manual details a transaction that reads identity data from a mobile driver's license (mDL) or mobile passport on a holder's phone.

Section

Information

0x1201 - Read Mobile Document

The host uses this command to start a mobile document transaction.

0x1202 - Age Verification for ISO18013-5

The host uses this command to start Age Verification through mobile document transaction.

Read Mobile Document

Applies to: All Dyna Family products

Information in this group

Need Help?

For additional support, please contact MagTek Support:

Technical Support:

  • πŸ“§ Email: support@magtek.com

  • πŸ“ž Phone: 1-562-546-6800 (US)

  • πŸ• Hours: Monday-Friday, 5:30 AM - 5:00 PM Pacific

Online Resources:

  • 🌐 Support Portal: developer.magtek.com

  • 🌐 Official Site:

Documentation Feedback:

Help us improve this documentation!

https://www.magtek.com
feedback@magtek.com