Skip to main content

API Reference Overview

Overview

The API reference documentation provides detailed information about BlockID SDK for Android.

Classes

Class NameSummary
AccessCodePayloadModel class to hold Access Code Payload data (attributes)
AccessCodeTypeEnum to define and create access code type
AnalyticsHelperHelper class to report an events
BIDAccountModel class to represent the user account data (attributes)
BIDAuthProviderThis class is responsible for managing different authentication types, such as a device's biometric features (fingerprint, face, pin, password, pattern lock), pin and Live ID
BIDDocumentDataHolderModel class to hold or represent the Scanned Document Data response (attributes)
BIDDocumentProviderThis class is responsible for all document management, such as adding or removing identity documents, and other miscellaneous documents
BIDGenericResponseModel class to represent the generic response object
BIDLinkedAccountModel class to represent the linked account data (attributes)
BIDOriginModel class to represent the origin data (attributes)
BIDPasswordPolicyModel class to hold password policy data (attributes).
BIDScannerViewA custom view class to be provided by application. The BIDScannerView is placed on top of Activity from where the document scanner is initiated
BIDTenantModel class to represent the tenant data (attributes)
BIDUtilHelper class which allows related methods to be reused
BiometricAssetsHelper class to check and determine if the type of biometric assets are enabled for the tenant
BlockIDSDKThe primary class and an entry point to the BlockID SDK. Handles initial setup required for the SDK and to access all BlockID SDK features
CreateAccessCodePayloadModel class to hold Create Access Code Payload (attributes)
CreateAccessCodeResponseModel class to hold Create Access Code Response (attributes)
DigitalAssetsHelper class to check and determine if the type of digital document assets are enabled for the tenant
DocumentScannerActivityThis class is used to start the document scanner and give results back to the application.
DocumentScannerTypeAn enum to define document scanner type.
EmailResultModel class to hold Email Result for created access code
EnrollmentsUtility class that helps BlockID SDK to determine which biometric (Pin, Live ID) and digital (Drivers License, Passport) assets are supported for each tenant. The Biometric and Digital assets registration is determined by the license module
FacePresenceLevelDefines the supported types of document scanners available in the BlockID SDK
GetAccessCodeResponseThis class holds the access code response data returned during the access code redemtion flow (attributes)
IPProviderThis class provides a mechanism for fetching and caching the user's IP address from a remote API.
IRFIDScanResponseListenerThis class defines methods for callback events related to Passport RFID Scanning.
LiveIDScannerHelperHelper class that works with Live ID
MessageGatewayModel class to hold MessageGateway data
PasswordRulesModel class to hold password rules.
PersonalAssetsHelper class to check and determine if the type of personal assets are enabled for the tenant
ProxyDetailsModel class to hold proxy information
QRScannerHelperHelper class that provides QR scanning functionality
RFIDScannerHelperThis helper class handles RFID scanning (E-Passport Chip).
TOTPUtility class to work with time based OTP feature
VersionAn enum to define create access code version
WorkstationAuthOriginModel class to represent the user's workstation authentication origin (attributes)

Error Handling Classes

Class NameSummary
AccountUtility class to manage Account errors
CaaSUtility class to manage CaaS errors.
CustomErrorsUtility class to manage various error codes and messages
DocumentScannerUtility class to manage Document Scanner errors.
ErrorResponseUtility class to manage error responses
KYCUtility class to manage KYC errors
LicenseUtility class to manage License errors
LiveIDScanningErrorUtility class to manage LiveIDScanning Error errors.
LiveIDSelfieUtility class to manage LiveIDSelfie errors.
SCEPAccountUtility class to manage SCEP Account errors
VCsUtility class to manage VCs errors