ID VERIFY SDK INTEGRATION GUIDE - Windows 

**Version 3.7 **

Purpose 

The ID Verify SDK is targeted to developers who want to develop an application that will verify the mobile driving license. The ID verify SDK is based on the ISO 18013-5. The purpose of this guide is to show the necessary steps to configure a sample application to test the SDK and to guide the developers to integrate the SDK with the application that they are developing

Release Notes 

• SDK is compatible with MID for Android & iOS
• Device Engagement using QR Code
• Data Transfer using BLE Mode
  • Central/Client
  • Peripheral/Server
• Reader Authentication is supported
• Load IACA Certificates from App or from a Directory
• Agnostic Scan (QR/PDF417)
• 2D-2D Rendering (Generate PDF417 Barcode from scanned PDF417 AMWAA data)
• IsDebugable flag is implemented
• All request parameters can be selected from App.
• Custom Namespace and custom fields support
• Multi Doc support as per N1818
• Intent to retain in Request
• Tagging certificate with Not for Official use is removed
• Supports .pem, .crt & .der formats for IACA certificates.
• Supports Elliptic Curve P-256, P-384 & P-521
• Supports multiple request in single session
• Multi Request in a single session
• Supports .pem, .crt & .der formats for IACA certificates.
• Added support for Elliptic Curves P-384 and P-521 for ECDH(Key Agreement-DH) and ECDSA.
• Supports ISO 18013-5, draft version N1677, N1818, N1938 and N1985
• Support NFC Static Handover using D-logic's NFC Device
• Support NFC Negotiated Handover using D-logic's NFC Device
• NFC Support for Curve P-384 & P-521
• Support for AAMVA 1.1

Additions and updates 

• NFC Agnostic Scan

Supported ISO Version 

Elliptic Curve Support 

Prerequisites 

Skills Required 

To integrate the SDK the developer should have knowledge of following:

• C#
• UWP framework ver#16299 and above in Visual Studio 2017 and above

Resources Required 

The tools required are:

• Windows 10 v1703 or higher
• Visual Studio 2017 Getting Started With Sample ID Verify SDK
• Webcam on PC
• Bluetooth on PC
• For testing SDK a Smartphone (iOS/Android) with mID application.
• For NFC using Dlogic's device, files uFCoder-x86.dll & uwp-serial-x86.dll are required in the Appication project.

Sample TestApp 

• Download from mi-artifactory: https://mi-artifactory.otlabs.fr/artifactory/verify-sdk-windows-release/com/idemia/idverify/windows

Getting Started With Sample ID Verify SDK 

Steps to test the sample application

• Prerequisite
  • The User should have Administrator privileges
  • The User should be in the Developer Mode
  • The current implementation uses Webcam for QR Scanning and BLE for data transfer. So, a Webcam and Bluetooth is must for executing the sample application and using SDK.
• The sample application will be provided as zip file consisting of following files:
  • Add-AppDevPackage.resources
  • Dependencies
  • Add-AppDevPackage.ps1
  • VerifySDK_App_x.x.x.0_x86.appxbundle
  • VerifySDK_App_x.x.x.0_x86.appxsym
  • VerifySDK_App_x.x.x.0_x86.cer
  • VerifySDKDlls (Folder containing all the Dlls)
• After extracting the files open Windows PowerShell as administrator and go to the folder location of the unzipped files.
• Then give the command .\Add-AppDevPackage.ps1
• This will show a progress bar and after installation following message will appear: Success: Your app was successfully installed.
• An application by name of ID.X Verify will be installed on the system.
• When the ID.X Verify app is executed then a UI page will appear with title Create New Namespace.
• On this page to enter Multiple Doc first enter data in N1818: Enter Doc Type then in Enter Namespace and in the last in Enter Fields for the Namespace. For the fields make sure that fields are seperated by comma (,). Click Add Fields.
• For ISO N1818 and above only select Set Retain Intent and then to set the Intent to Retain to True check the boxes corresponding of fields in Intent to Retain Fields.
• Select the fields that needs to be added into the request by checking the fields and then clicking Add Selected Fields
• For the same Doc Type to add more namespaces and their fields just enter new namespace name in Enter Namespace and fields in Enter Fields for the new Namespace seperated by comma (,).
• Once done adding new Doc Type and namespaces click Next Page.
• Custom namespace page can be accessed using the button Custom Namespace Page
• On the Main page N1818 is selected as the default ISO version and fields as per the ISO are Displayed. Select the correct ISO version from ISO Version drop down list
• Select the fields and then click Set Retain Intent for ISO N1818 & ISO N1901/N1938 only. List of all the selcted fields will be displayed in Retain Intent (N1818 Only), check the box for which user want Intent to Retain to be True, by default it is false.
• For N1901/N1938 "given_name_national_character" & "family_name_national_character" is added in the fields.
• For using NFC add files uFCoder-x86.dll & uwp-serial-x86.dll in the Application project. After adding the files change their properties and mark property Build Action as Content.
• These files are present in the VerifySDKDll\Dlls folder of the TesteApp.
• Under NFC Option check Static Handover for Device Engagement using Static Handover or check Negotiated Handover for Device Engagement using Negotiated Handover.
• Both Static Handover & Negotiated Handover options can't be selected. Only one can be selected.
• For multiple request in single session select Multiple Request
• To disconnect from a connected device during multiple request select Disconnect Device.
• Currently this application only supports Device Engagement using QR. So, for QR scanning a webcam is used.
• A mobile device (iOS or Android) will be need with installed mID application for performing this test.
• On the mobile start the application in Peripheral mode and generated the QR code.
• To check condition that age is over a certain value, select a value from Age Over NN
• Select Is Debugable to yes when the user wants to display the logs on the Visual Studio's output screen. On enabling it Transaction Time will also be displayed.
• When barcode is PDF417 then Age Over NN response will be based upon calculating age. If the barcode is QR then the whatever response is received from MobileID will be shown.
• Fields for request can be selected from the list as shown below. Following fields will be there for selection, some fields will change as per the ISO version:
  • "RealID"
  • "family_name"
  • "given_name"
  • "birthdate"
  • "issue_date"
  • "expiry_date"
  • "issuing_country"
  • "issuing_authority"
  • "driving_privileges"
  • "portrait"
  • "mgmt_lastupdate"
  • "mgmt_validity"
  • "online_token_xxxx"
  • "administrative_number"
  • "gender"
  • "height"
  • "weight"
  • "eye_color"
  • "hair_color"
  • "birthplace"
  • "resident_address"
  • "portrait_capture_date"
  • "age_in_years"
  • "age_birth_year"
  • "age_over_NN"
  • "issuing_jurisdiction"
  • "nationality"
  • "resident_city"
  • "resident_state"
  • "resident_postal_code"
  • "biometric_template_xx"
  • "name_nat_char"
  • "mgmt_nextupdate"
• Fields for AAMVA 1.1 and above, can be selected from the list as shown below.
  • "domestic_driving_privileges"
  • "name_suffix", "audit_information"
  • "organ_donor", "veteran"
  • "aamva_version"
  • "family_name_truncation"
  • "given_name_truncation"
  • "aka_family_name"
  • "aka_family_name.v2"
  • "aka_given_name"
  • "aka_given_name.v2"
  • "aka_suffix"
  • "weight_range"
  • "race_ethnicity"
  • "DHS_compliance"
  • "DHS_temporary_lawful_status"
  • "EDL_credential"
  • "resident_county"
  • "hazmat_endorsement_expiration_date"
  • "sex"
• To perform the compete data transfer using QR Code click QR Scan and for NFC click NFC Scan
• When using QR for the First time a popup will come asking to install a webcam from Microsoft Store
• A webcam UI will popup. Scan the QR/PDF417 by placing the QR/PDF417 in the middle of the rectangle box of the UI.
• For QR entire Device engagement and data transfer will take place between VerifySDK and mID.
• But for PDF417 an image will be generated using the data of the scanned PDF417. The generated image will be saved by the name generatedPDF417.jpg. It is recommended to open this image using Paint
• The final response will be showing in the Received Response text box.

Getting Started with App Development using ID.X Verify SDK 

References Required

• UWP Application -VerifySdkDll (Output Dll file of VerifySdkDll)

  • Zxing.Net
  • uFCoder-x86.dll
  • uwp-serial-x86.dll

• VerifySdkDll (Use Nuget Package Manager for installation)

  • Bouncy Castle
  • PeterO.Cbor
  • IdParser
  • Zxing.Net

Public Class Data Fields 

Include namespace VerifySdkDll into the project The Class that will contain the Data for Developer is following

Language not specified
1public class VerifySDKReturn
2{    
3    public string Version = null;
4    public string IsoVersion = string.Empty; /* Version of ISO from Device Engagement */
5    public int ErrorCode = 0;
6    public Dictionary<string, int> FieldsWithError = new Dictionary<string, int>();
7    public Dictionary<string, Dictionary<string, string>> DataFields = new Dictionary<string, Dictionary<string, string>>();
8    public Dictionary<string, string> ErrorDetails = null;
9    public Dictionary<string, string> PDF417RecvData = new Dictionary<string, string>();
10    public string QRData = null;
11    public string PDF417Data = null;    
12    public Dictionary<string, string> DSCertificateInfo = new Dictionary<string, string>();
13    public bool MSOVerified = false;
14    public Dictionary<string, string> Testing = new Dictionary<string, string>();
15    public bool isPDF47Generated = false;
16    static public bool isTestingAppUsed = false;
17    public bool DeviceAuthHMACVerified = false; /* HMAC Verification of the mDL Device */
18    public bool DeviceAuthECDSAVerified = false; /* ECDSA Verification of the mDL Device */
19    public bool ValueDigestVerified = false;
20    public bool AreAllSecurityChecksPassed = false; /* Check Whether All Security Checks are Passed */
21    public ResponseAuthWithDS ResponseAuthWithDSObj = null;
22    public DomesticDrivingPrivilage DomesticDrivingPrivilageObj { get; set; } = null;  /* AAMVA 1.1 */
23}

Description of Each Data Fields of Class VerifySDKReturn:

• Version: Contains the Version of the Mobile ID
• IsoVersion: Version of ISO from Device Engagement
• ErrorCode: Contains the Error code returned by the Mobile ID
• FieldsWithError: Contains the requested Fields against which an error code returned
• DataFields: contains the valid response against the requested fields
• ErrorDetails: Contains the information describing the details corresponding to the Error code received from Mobile ID
• QRData: Contains the Scanned QR Code
• PDF417RecvData: Parsed data from PDF417
• PDF417Data: PDF417 data
• DSCertificateInfo: Contains DS Certificate related information w.r.t. IACA. It contains following information
  • DSCertificateVerified (Response on the validation of the Certificate)
• MSOVerified: Confirms whether the MSO is verified or not
• Testing: Contains data which is used in the Sequential SDK Testing. Should Not be used for Development purposed as this filed is specifically used for testing purpose
• isPDF47Generated: Check whether PDF417 is generated
• isTestingAppUsed: Check whether data in the testing field will be used
• DeviceAuthHMACVerified: Confirm if the mDL Device is Authenticated using HMAC.
• DeviceAuthECDSAVerified: Confirm if the mDL Device is Authenticated using ECDSA.
• ValueDigestVerified: Check whether value digest of each received fields are verified or not.
• AreAllSecurityChecksPassed: Check Whether All Security Checks are Passed
• ResponseAuthWithDSObj: Object of class ResponseAuthWithDS
• DomesticDrivingPrivilage: Response Object for Domestic Driving Privilage as per AAMVA 1.1

Language not specified
1public class DomesticDrivingPrivilage
2{
3    public string ElementValue { get; set; } = string.Empty;
4    public Dictionary<string, List <Dictionary<string, string> >> AamvaResponseData { get; set; } = new Dictionary<string, List <Dictionary<string, string> >>();
5}

Description of Each Data Fields of Class DomesticDrivingPrivilage

• ElementValue: Name of the Main structure of Domestic Driving Privilage

• AamvaResponseData: Dictionary for each component of the Domestic Driving Privilage.

Language not specified
1public class ResponseAuthWithDS
2{
3    public bool isIssuingJurisdictionMatchWithDS { get; set; } = false;
4    public bool isIssuingCountryMatchWithDS { get; set; } = false;
5}

Description of Each Data Fields of Class ResponseAuthWithDS

• isIssuingJurisdictionMatchWithDS: Verify whether Juridiction is maction with DS certificate
• isIssuingCountryMatchWithDS: Verify whether Country is maction with DS certificate

Language not specified
1public class MultiDocRequest
2{
3    public string docType { get; set; } = string.Empty;    
4    public Dictionary<string, Dictionary<string, bool>>  CustomNamespaceFields { get; set; } = new Dictionary<string, Dictionary<string, bool>>();   /* Namespace with Fields and their intent to retain.  Dictionary<string: "Namespace" , Dictionary<string, bool>: "Field Name", "Intent to Retain(True/False)">*/
5    public Dictionary<string, Dictionary<string, Dictionary<string, string>>> RequestInfoFields { get; set; } = new Dictionary<string, Dictionary<string, Dictionary<string, string>>>();     /*** Dictionary for RequestInfo Map for a Doc Type. Dictionary<string: "Namespace", Dictionary<string: "Field Name", Dictionary<string, string>: "Presense","True/False">> ***/
6}

Description of Each Data Fields of Class MultiDocRequest

• docType: Name of the DocType
• CustomNamespaceFields: Dictionary for the Fields of the Namespaces
• RequestInfoFields: Dictionary for RequestInfo Map

Language not specified
1public class Nfc
2    {
3        internal bool NfcStaticHandover { get; set; } = false;
4        internal bool NfcNegotiatedHandover { get; set; } = false;
5        public string NfcData { get; set; } = string.Empty;
6    }

Description of Each Data Fields of Class Nfc

• NfcStaticHandover: Check whether NFC Static Handover is selected
• NfcNegotiatedHandover: Check whether NFC Negotiated Handover is selected
• NfcData: NFC data read from the NFC device.

Language not specified
1public class ApiConfigs
2{    
3    public Dictionary<string, string> DevEngErDetails = null;
4    public string JPGPath = null;
5    public string JPGBarcodeData = null;
6    public Dictionary<string, string> DevEngPDF417Data = new Dictionary<string, string>();
7    public int BarcodeType = 0;
8    public string[] ReqParameters = null;     /*** Array of Strings Containing the Requested optional Parameters for Pre-Defined Namespaces in SDK as per ISO ***/
9    public Dictionary<string, List<string>> CustomNamespaceFields = new Dictionary<string, List<string>>();     /*** Dictionary for Custom Namespaces & their Fields ***/
10    public int AgeOverNN = 0;
11    public List<MultiDocRequest> MultiDocRequestList = null; /* List of *RequestInfo* class for MultiDoc support as per N1818 version of ISO 18013-5 */
12    private ReaderAuthSignerCallback readerAuthCallback = null;
13    private Dictionary<int, int> Algorithm = new Dictionary<int, int>();
14    public ApiConfigs setReaderAuthInfo(ReaderAuthSignerCallback readerAuthSignerCallback, ReaderAuthAlgorithm signingAlgo, ApiConfigs ConfigData)
15    public MultipleRequest MultipleRequestObj = new MultipleRequest(); /* Multirequest */
16    public Nfc NfcObj = null; /* NFC Class Object */
17}

Description of Each Data Fields of Class ApiConfigs:

• DevEngErDetails: Error details
• JPGPath: Path to the location of the JPG file
• JPGBarcodeData: Data present in the JPG file code
• DevEngPDF417Data: Data present in the PDF417 barcode
• BarcodeType: Barcode type as per Zxing Library
• ReqParameters: Array of Strings Containing the Requested optional Parameters for Pre-Defined Namespaces in SDK as per ISO
• CustomNamespaceFields: Dictionary for Custom Namespaces & their Fields
• AgeOverNN: Age in integer
• MultiDocRequestList: List of RequestInfo class for MultiDoc support as per N1818 version of ISO 18013-5
• readerAuthCallback: readerAuthCallback object used to set when Reader Authentication is requested
• Algorithm: This is the signing algorithm provided by integrator from the enum list provided by SDK
• setReaderAuthInfo: To set reader authentication information i.e callback object and Signing Algorithm. signingAlgo parameter accepts value from list of Enums provided by SDK
• MultipleRequestObj: Object of MultipleRequest class, for multiple request in single session.
• NfcObj: Object of NFC Class

Language not specified
1public class Config
2{
3    internal bool isDebugable = false;     
4    public void enableDebug();
5}

Description of Each Data Fields of Class Config:

• isDebugable: Enable Debug mode to display log in IDE (Visual Studio)
• enableDebug(): enables the isdebugable flag to display log.

Language not specified
1public interface ReaderAuthSignerCallback
2{
3    ReaderAuthSign doSignItemRequest(byte[] readerAuthenticationBytes);
4}

Description of interface: Verify sdk will call doSignRequest with the readerAuthenticationSigBytes to be signed by the integrator with its private key. Integrator will give back the Signature and X509 Certifcate having Pub Key. SDK will share "ReaderAuth" COSE_SIGN1 structure in Request with mDL

Language not specified
1public class ReaderAuthSign
2{
3    public byte[] X509Cert;
4    public byte[] signature;
5}

Description of Each Data Fields of Class ReaderAuthSign:

• signature -Calculated signature
• x509Certificate - X509 Certifcate having Pub Key

Language not specified
1public enum ReaderAuthAlgorithm
2{
3    ALGO_SHA256WITHECDSA = -7,
4    ALGO_SHA384WITHECDSA = -35,
5    ALGO_SHA512WITHECDSA = -36,
6    ALGO_NONEWITHEDDSA = -8
7}

Description : Enum class to provide list of supported Algorithms

Language not specified
1public delegate void OnSuccess(int NumCert);   /* Delegate for On Success */
2public delegate void OnError(Dictionary<string, string> ErrorCode);  /* Delegate for On Failure/Error */
3public class DelegateClassOfflineCertificate
4{
5    public OnSuccess OnSuccessDelegate { get; set; };
6    public OnError OnErrorDelegate { get; set; };
7}

• Description: These are the Delegates/Callbacks for Loading Offline Certificates
  • OnSuccess: Callback on Success. The int value contains the Total number of Certificates loades
  • OnError: Callback on Error. The Dictionary containes the Error code and description.

Language not specified
1public delegate void UpdateMultiRequestConnectionStatus(bool Status);   /* Delegate for checking Connection Status*/

• Description: These are the Delegates/Callbacks for Multiple Request in single session
  • UpdateMultiRequestConnectionStatus: The status parameter describes the connection status of the device

Language not specified
1public class MultipleRequest
2{
3    public bool isMultipleRequest { get; set; } = false; /* Check if Multiple Request will be send */
4    public bool DisconnectConnection { get; set; } = false; /* Disconnect the BLE connection from Connected Device */
5    public bool isDeviceAlreadyConnected { get; set; } = false; /* Check if the BLE connection with the MID is still active */
6    public  UpdateMultiRequestConnectionStatus UpdateMultiRequestConnectionStatusCallback { get; set; } 
7}

• Description: Class of Multiple Request
  • isMultipleRequest: Check if Multiple Request will be send
  • DisconnectConnection: Disconnect the BLE connection from Connected Device
  • isDeviceAlreadyConnected: Check if the BLE connection with the MID is still active

ID.Verify SDK Public APIs/Functions to be used by App Developer 

• Include namespace VerifySdkDll into the project
• There are public APIs that are included in public class InterfaceVSDK

Language not specified
1public async Task<VerifySDKReturn> sendRequest(ApiConfigs ConfigData)
2    public async Task<VerifySDKReturn> initDeviceEngagement(ApiConfigs config)
3    public async Task<VerifySDKReturn> parsePDF417(ApiConfigs config)
4    public static async Task<InterfaceVSDK> getClient(Config ConfigData) 
5    public static  async Task LoadCertificates(String DirLink, DelegateClassOfflineCertificate DelegateClassObj)
6    public async Task<BluetoothConnectionStatus> MultiRequestDisconnectFromDevice(VerifySDKReturn RecvData, ApiConfigs ConfigData)

• Description of Each API
  • getClient(): Return a valid InterfaceVSDK object if request is valid
  • initDeviceEngagement (): Uses the data from the JPGBarcodeData data field on successful scan, else throws an exception with Details of Error mentioned in ErrorDetails. Uses this data to initiate the device engagement.
  • parsePDF417 (): Parses the scanned PDF417 and returns the data. If there is any error in parsing then an exception is thrown with Details of Error mentioned in ErrorDetails
  • sendRequest (): On successfully parsing the QR data, this API accepts as second parameter a string[] of the fields requested by the developer. If this field is null then by default a request is generated containing all the 33 fields mentioned in 18013-5. If any error occurs between generating request and receiving response from Mobile ID then the error details are mentioned in ErrorDetails. This is the last API that has to be called. After successfully completing all the operations, the necessary fields mentioned for the class VerifySDKReturn will be updated. The developer can then use the data present in the fields as per their implementation
  • LoadCertificates(): Loads the Certificates from the DirLink and corresponding response is shared using delegates from class DelegateClassOfflineCertificate
  • MultiRequestDisconnectFromDevice(): In multiple request to disconnect from connected device this API is used.

Sample Code for MainPage.xaml.cs for calling the public APIs of ID Verify SDK 

Language not specified
1Config initConfig = new Config();
2ApiConfigs ConfigData = new ApiConfigs();
3InterfaceVSDK VsdkInterface = await InterfaceVSDK.getClient(initConfig);
4    if (MultipleRequestObjApp.isDeviceAlreadyConnected == false)
5    {
6        /*** Get Data Present in the Barcode Picture ***/
7        await AppBarcodeData.getBarcodeData(ConfigData);
8        if (MultipleRequestObjApp.isMultipleRequest) /* On Multiple Request store QR Data */
9        {
10            BarcodeDataMultiRequest = ConfigData.JPGBarcodeData;
11            BarcodeTypeMultiRequest = ConfigData.BarcodeType;
12        }
13        VsdkInterface = InterfaceVSDK.getClient(initConfig);
14        if (VsdkInterface != null)
15        {        
16            if (ConfigData.DevEngErDetails == null)
17            {
18                if (ConfigData.BarcodeType == (int)BarcodeType.QR)
19                {
20                    RecvData = VsdkInterface.initDeviceEngagement(ConfigData);
21                    if (RecvData.OpticalInspectionResponseObj == null)
22                    {
23                        if (RecvData.ErrorDetails == null)
24                        {
25                            if (ReaderCheckBox.IsChecked == true)
26                            {
27                                IReaderAuthSignerCallback obj = new TestApiConfig();
28                                ConfigData.setReaderAuthInfo(obj, ReaderAuthAlgorithm.ALGO_SHA256WITHECDSA, ConfigData); 
29                            }
30                            RecvData = await VsdkInterface.sendRequest(ConfigData);                                                
31                        }
32                    }
33                }
34                else if (ConfigData.BarcodeType == (int)BarcodeType.PDF417)
35                {
36                    RecvData = VsdkInterface.parsePDF417(ConfigData);
37                    if (RecvData.ErrorDetails == null)
38                    {
39                        RecvData = await VsdkInterface.GeneratePDF417(RecvData, ConfigData); /* Generate PDF417 Using SDK*/
40                    }
41                }
42            }        
43        }
44    else /* MultiRequest: When devices are connected then only send the request */
45    {
46        ConfigData.JPGBarcodeData = BarcodeDataMultiRequest;
47        ConfigData.BarcodeType = BarcodeTypeMultiRequest;
48        RecvData = await VsdkInterface.sendRequest(ConfigData);
49    }

Language not specified
1private async void DiconnectFromDevice(object sender, RoutedEventArgs e)
2{    
3    MultipleRequestObjApp.DisconnectConnection = true; /* Disconnect*/
4    var Status = await VsdkInterface.MultiRequestDisconnectFromDevice(null, ConfigData);
5
6    if (Status.ToString() == "Disconnected")
7    {
8        MultipleRequestObjApp.isDeviceAlreadyConnected = false;
9    }
10    else
11    {
12        MultipleRequestObjApp.isDeviceAlreadyConnected = true;
13    }          
14}

Language not specified
1*** V2 Architecture APIs ***

Language not specified
1public enum ConnectionType { NFC = 1, BLE, WifiAware };
2public enum DisconnectConnectionType { NFC = 1, BLE, WifiAware, All };
3
4public static async Task<InterfaceVSDK> getClient(Config ConfigData) 
5
6/* V2 Device Engagement */
7public delegate void DevEngSuccessCallback(bool Result);
8public delegate void DevEngEngagementModelCallback(VerifySdkReturn VsdkRet);
9public void  initDeviceEngament(ApiConfigs ConfigData, int ConnectionType, DevEngSuccessCallback SuccessCallback, DevEngEngagementModelCallback ModelCallback)
10
11/* V2 Prepare Connection */
12public delegate void PrepareConnectionStatusCallback(bool Result);
13public async Task prepareConnection(VerifySdkReturn RecvData, ApiConfigs ConfigData, int ConnectionType, PrepareConnectionStatusCallback ConnectStatus)
14
15/* V2 Send Request */
16public delegate void ResponseCallback(VerifySdkReturn RecvData);
17public async Task sendRequest(ResponseCallback ResCallback, ApiConfigs ConfigData)
18
19/* V2 Terminate Session */
20public delegate void TerminateSessionCallback(bool Result);
21public async Task terminateSession(int CancelReason, TerminateSessionCallback TermSessCall)
22
23/* V2 Terminate Connection */
24public async Task terminateConnection(int CancelReason, TerminateConnectionCallback TermConnCall)
25public delegate void TerminateConnectionCallback(bool Result);

• Description of Each API
  • getClient(): Return a valid InterfaceVSDK object if request is valid
  • initDeviceEngagement(): Accepts object of ApiConfigs, type of connection, Callback for success, Callback for the DeviceEngagementModel.
  • prepareConnection(): Creates connection with the MID. Accepts object of VerifySdkReturn, Accepts object of ApiConfigs, type of connection, Callback for PrepareConnectionStatusCallback.
  • sendRequest(): Sends request to the MID. Callback for ResponseCallback, Accepts object of ApiConfigs.
  • terminateSession(): Terminates connection with device but the information received during Device Engagement is not erased and can be used later. Accepts reason for cancellation, Callback for TerminateSessionCallback.
  • terminateConnection(): Terminates Connection with device and all data received during Device Engagement is removed. Accepts reason for termination, callback for TerminateConnectionCallback.

Setting at the App side 

• Enable following permission using Package.appmanifest ->Capabilities in the UWP application project
  • Bluetooth
  • Point of Service
  • Webcam

Errors Codes 

D-Logic NFC Device's Error Codes