Skip to main content

NationalIDScanHelper

public class NationalIDScanHelper extends Object

↳ package com.onekosmos.blockid.sdk.cameramodule.nationalID

This is the helper class that provides National ID document scanning functionality.

  • All documents (Identity and Miscellaneous) must have following baseline attributes.
Parameters
Stringid: It represents the document's ID eg: driver license number.
Stringcategory: Currently this SDK supports two categories for documents that can be registered i.e, identity_document or misc_document.
Stringtype: This represents the type of document that the user will try to register eg: pin, dl, ppt, liveid, nationalid.
StringproofedBy: This identifies the entity responsible for proofing the document. When you use BlockID SDK Scanners, this defaults to “blockid”.
  • The identity documents must have following baseline attributes.
Parameters
StringfirstName: First name of document holder.
StringlastName: Last name of document holder.
Stringdob: Date of birth {yyyyMMdd} of document holder.
Stringdoe: Date of expiry {yyyyMMdd} of document.
Stringface: Base64 string of document holder's face photo.
Stringimage: Base64 string of document image.

Constructor​

public NationalIDScannerHelper(Context context, NationalIDScanOrder scanOrder, BIDScannerView bidScannerView, View scannerOverlay, int expiryDateGracePeriod, boolean isDataRequiredOnFail, INationalIDResponseListener callback)

  • Creates an object of NationalIDScannerHelper. The scanner will throw an error if the document has already expired. If the document expires before the grace period, the scanner will complete the scan and return an advisory error.
note

It is the application's responsibility to decide if the scanned National ID should be registered or not.

Parameter
contextContext: Application's context.
scanOrderNationalIDScanOrder: An enum value for National ID document scanning order.
bidScannerViewBIDScannerView: An object of BIDScannerView.
scannerOverlayView: An overlay to be placed on top of the BIDScannerView object.
expiryDateGracePeriodint: Number of days to allow as grace period ahead of National ID document expiry.
isDataRequiredOnFailboolean: Indicates if the scanner must return the National ID document data. The default value is false.
callbackINationalIDResponseListener: The block to execute after the National ID document scanning is completed.

public NationalIDScannerHelper(@NonNull Context context, @Nullable NationalIDScanOrder scanOrder, @NonNull BIDScannerView bidScannerView, View scannerOverlay, int expiryDateGracePeriod, @NonNull INationalIDResponseListener callback)

  • Creates an object of NationalIDScannerHelper. The method does not return the data in case National ID document scanning is failed. The scanner will throw an error if the document has already expired. If the document expires before the grace period, the scanner will complete the scan and return an advisory error.
note

It is the application's responsibility to decide if the scanned National ID should be registered or not.

Parameter
contextContext: Application's context.
scanOrderNationalIDScanOrder: An enum value for National ID document scanning order.
bidScannerViewBIDScannerView: An object of BIDScannerView.
scannerOverlayView: An overlay to be placed on top of the BIDScannerView object.
expiryDateGracePeriodint: Number of days to allow as grace period ahead of National ID document expiry.
callbackINationalIDResponseListener: The block to execute after the National ID document scanning is completed.

public NationalIDScannerHelper(@NonNull Context context, @Nullable NationalIDScanOrder scanOrder, @NonNull INationalIDResponseListener callback)

  • Creates an object of NationalIDScannerHelper. The methods does not return the data in case National ID document scanning is failed. The scanner will complete the scan and return an advisory error.
note

It is the application's responsibility to decide if the scanned National ID should be registered or not.

Parameter
contextContext: Application's context.
scanOrderNationalIDScanOrder: An enum value for National ID document scanning order.
callbackINationalIDResponseListener: The block to execute after the National ID document scanning is completed.

Method Summary​

Parameters
voidstartNationalIDScanning()Starts the National ID document scanner.
voidstopScanning()Stops the National ID document scanner.

Method Detail​

startNationalIDScanning​

public void startNationalIDScanning()

  • Starts the National ID document scanner.

stopScanning​

public void stopScanning()

  • Stops the National ID document scanner.

Interface Summary​

Parameter
INationalIDResponseListenerCallback for the event when National ID document scanning is completed.

INationalIDResponseListener​

public interface INationalIDResponseListener

↳ package com.onekosmos.blockid.sdk.cameramodule.camera.nationalID

  • Callback for the event when National ID document scanning is completed.

Method Details​

void onNationalIDScanResponse(LinkedHashMap<String, Object> nationalIDMap, String signatureToken, ErrorManager.ErrorResponse error)

  • A callback method which is triggered after the National ID document scanning is completed.
Parameters
nationalIDMapLinkedHashMap<String, Object>: Returns the National ID document data after the scanning is completed.
signatureTokenString: A token which carries information about scanned National ID document. This is used to verify if the National ID document data is modified or not before storing it to BlockID blockchain platform.
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

default void scanBackSide()

  • A callback method to indicate that the scanner has started the back side of the National ID document.

default void scanFrontSide()

  • A callback method to indicate that the scanner has started the front side of the National ID document.

default void verifyingDocument()

  • A callback method to indicate that the scanner has started Document verification of NationalID.