NFC Activity Parameters
Detect User Agent Capabilities
This activity is used to collect information regarding the device capabilities.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Key | The AuthenticID account code. | STRING | userAgent1 |
| List of Screens | The list of screens to be presented to the user. | LIST_STRING | capabilities |
| Starting Component ID | The name of the capture step to be sent to the UI. | STRING | capabilities |
| UI Component ID | The name of the screen used in the capture UI. | STRING | capabilities |
MRZ Processor
A cropped image will read the MRZ and perform basic parsing of the MRZ. This activity currently only supports TD3 ICAO compliant MRZ such as those found on ICAO passports.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Document Key | The document key | STRING | doc1 |
| Document Side | Determines which side of the document will be read. Given that passports are the only document currently supported, FRONT is the only supported value. As more documents are supported, other values may be supported in the future. |
STRING | FRONT |
| Image Profile | The profile of the image to be used for MRZ reading. Only Cropped is supported. | STRING | Cropped |
| Raise Error on MRZ Not Found | Raise an exception if the MRZ is not found or the MRZ cannot be read. | BOOLEAN | ${true} |
Enable NFC
If NFC is not enabled, then this activity will bring the user to the settings screen on the native app to enable NFC.
| Parameter | Description | Type | Default |
|---|---|---|---|
| List of Screens | The list of screens to be presented to the user. | LIST_STRING | enable |
| Starting Component ID | The name of the capture step to be sent to the UI. | STRING | nfc-capture |
| UI Component ID | The name of the screen used in the capture UI. | STRING | enable |
NFC Instructions
A page that displays the instructions on how to perform NFC capture before capture. If a customer wishes to put their own specific customized instructions page in place this page can be replaced by a custom page or custom form.
| Parameter | Description | Type | Default |
|---|---|---|---|
| List of Screens | The list of screens to be presented to the user. | LIST_STRING | |
| Starting Component ID | The name of the capture step to be sent to the UI. | STRING | nfc-capture |
| UI Component ID | The name of the screen used in the capture UI. | STRING | instructions |
NFC Error
A page that displays a generic NFC error if there has been an error during capture or processing. If a customer wishes to put their own specific customized error page in place, this page can be replaced by a custom page or custom form.
| Parameter | Description | Type | Default |
|---|---|---|---|
| List of Screens | The list of screens to be presented to the user. | LIST_STRING | |
| Starting Component ID | The name of the capture step to be sent to the UI. | STRING | nfc-capture |
| UI Component ID | The name of the screen used in the capture UI. | STRING | error |
Capture & Process NFC
Performs the action of reading the document’s chip data using NFC.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Active Authentication Required | Defines whether active authentication is required. If set as True all documents must complete Active Authentication. If the submitted document does not support AA it will fail this check. | BOOLEAN | false |
| Card Access Number | Required for PACE - this value typically comes from the optional data in the MRZ if present. | INTEGER | |
| CSCA Required | Determines if the server should check the country signing certificate’s certificate authority. | BOOLEAN | true |
| Date of Birth | Date of Birth is used to unlock the document chip. If not supplied then a value from the MRZ String will be used. The Date Of Birth could come from the following places:
|
DATE | |
| Document Key | The key of the document that is being processed. | STRING | doc1 |
| Document Number | Document Number is used to unlock the document chip. If not supplied then a value from the MRZ String will be used. The document number could come from the following places:
|
INTEGER | |
| Expiration Date | Expiration is used to unlock the document chip. If not supplied then a value from the MRZ String will be used. The Date Of Expiry could come from the following places:
|
DATE | |
| Generate Active Authentication Challenge | Defines if an active authentication challenge should be generated. If set as True and the submitted document does not support AA the check result will return as NA. | BOOLEAN | ${true} |
| List of Screens | The list of screens for NFC scanning. Only a single value is required here ‘scan’ | LIST_STRING | [scan] |
| MRZ | This is the MRZ string.If date of birth, date or expiry, document number and card access number (for PACE) are not supplied then the MRZ will be parsed to extract the required information to unlock the chip on the device.
|
STRING | |
| NFC Configuration Name | The NFC configuration name which is used for server-side validation of the documents' chip data | STRING | |
| NFC Configuration Version | The NFC configuration version which is used for server-side validation of the documents' chip data | INTEGER | |
| Retryable Client Error Status | This is the list of errors which can cause a retryable error - if an error is not no this list it will be classified as a non retryable error. | LIST_STRING | ["NFC_USER_CANCELED", "NFC_INPUT_PARSING_ERROR", "NFC_BACKGROUND_READING_FAILED", "NFC_DATA_INCOMPLETE", "NFC_READER_NO_DATA_ERROR", "NFC_READER_INTERRUPT_ERROR", "APP_PROCESS_BACKGROUNDED", "OPERATION_INPUT_PARSING_ERROR"] |
| Starting Component | The name of the capture step to be sent to the UI. | STRING | nfc-capture |
| UI Component ID | The name of the screen used in the capture UI | STRING | scan |
The client times out 10 seconds before the time configured in the timer boundary event that is associated with the 'Capture & Process NFC' activity.
For example, if the timer is set to PT30s (30 seconds), the activity will timeout after 20 seconds. This allows the application time to make the timeout call before the server marks the operation as abandoned.
The timeout error can be retryable or non-retryable depending on the configuration of the activity. If the 'NFC_READER_NATIVE_TIMEOUT_' and '_CLIENT _TIMEOUT' are configured on the 'Retryable Client error Statuses' input parameter, then the timeout error will be retryable and will follow the flow of the retryable boundary event.
NFC Retryable Errors
This input parameter will enable users to define which errors can be shown to the end-user in the event that an error occurs when capturing and processing NFC data. The table below provides a full list of possible errors and their descriptions.
| NFC Error Code | NFC Error Description | Supported on Android | Supported on iOS |
|---|---|---|---|
| NFC_User_Cancelled (1001) | Canceled by click on the “Cancel” button on the NFC dialog |  |  |
| NFC_INPUT _PARSING_ERROR (1003) | Input data (BAC, MRZ) parsing failed. |  |  |
| NFC_BACKGROUND _READING_FAILED (1005) | NFC reading interrupted by app going into background. |  |  |
| NFC_DATA _INCOMPLETE (1006) | NFC scanning finished with incomplete data (some data groups were not read/parsed successfully). |  |  |
| NFC_READER _NO_DATA_ERROR (1007) | NFC reader returns TagError.ERROR_NO_DATA code. |  |  |
| NFC_READER _INTERRUPT_ERROR (1008) | NFC reader returns TagError.ERROR_UNEXPECTED code when parsing available data groups. |  |  |
| APP_PROCESS _BACKGROUNDED (2003) | Application was put to background by user. |  |  |
| OPERATION_INPUT _PARSING_ERROR (2002 ) | Input payload provided in operation call is invalid. |  |  |
| CLIENT_TIMEOUT | The application has timed out after the allotted time has passed. |  |  |
| NFC_READER _NATIVE_TIMEOUT | NFC Dialog has been cancelled after system timeout. |  |  |
NFC Face Match v1
Face match of the Face image from the Document Chip against a face captured via Face Capture activity.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Document Key | The key of the document that is being processed. | STRING | doc1 |
| Error Navigation Screen | See previous docs. This is the screen that should be opened when if the PD goes back to in input activity which takes the screen as an argument. In case of NFC face image to selfie failing - the only corrective action that can be taken is to retake the selfie. |
STRING | instructions |
| Exception on Max Attempts Exceeded | Throw Exceeded Face match count error if the number of face matches has been exceeded. | BOOLEAN | ${true} |
| Face Key | The key of the face used for matching. | STRING | face1 |
| Face Match Threshold | The face matching threshold. | DOUBLE | ${0.339689} |
Early Access
NFC Face Match v2
Face match of the Face image from the Document Chip against a face captured via Face Capture activity.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Document Key | The key of the document that is being processed. | STRING | doc1 |
| Error Navigation Screen | See previous docs. This is the screen that should be opened when if the PD goes back to in input activity which takes the screen as an argument. In case of NFC face image to selfie failing - the only corrective action that can be taken is to retake the selfie. |
STRING | instructions |
| Exception on Max Attempts Exceeded | Throw Exceeded Face match count error if the number of face matches has been exceeded. | BOOLEAN | ${true} |
| Face Key | The key of the face used for matching. | STRING | face1 |
| Face Match Threshold | The face matching threshold. | DOUBLE | ${0.3010674949749498} |
| Internal Face Match Threshold | The internal face matching threshold. | DOUBLE | ${0.28968} |
| Max Attempts | The maximum number of attempts allowed before an error is thrown. | INTEGER | ${3} |