Skip to main content

API Reference Overview

Overview

The API reference documentation provides detailed information about BlockID SDK APIs for iOS. The APIs are available in Swift.

Classes

Class NameSummary
AccessCodeResponseDataPayloadModel class to hold the access code payload data (attributes).
AccessCodeTypeAn enum to define and create the access code type
AccessCodeValidationResponseDecryptedDataDuring the access code redemption flow, this class holds the access code response data (attributes).
BIDAccountModel class to represent the user account data (attributes).
BIDAuthProviderThis class is responsible for managing different authentication types, such as device biometrics (fingerprint, face, pin, password, pattern lock), pin & Live ID.
BIDDocumentProviderThis class is responsible for all document management, such as adding and removing identity documents and other miscellaneous documents.
BIDLinkedAccountModel class to represent the linked account data (attributes)
BIDOriginModel class to represent origin data (attributes).
BIDPasswordPolicyModel class to represent the password policy (attributes)
BIDScannerViewA custom view class to be provided by the application. The BIDScannerView is placed on top of the activity from where the document scanner is initiated.
BIDTenantModel class to represent the tenant data (attributes).
BiometricAssetsHelper class to check and determine if the type of biometric assets are enabled for the tenant.
BlockIDSDKThis is the primary class and an entry point to the BlockID SDK. The class is used to do the initial setup required for the SDK and to access all of its features.
DLScanningSideAn enum to define Drivers License document scanning order.
DigitalAssetsHelper class to check and determine if the type of digital document assets are enabled for the tenant.
DriverLicenseDataModel class to represent Drivers License document data.
DriverLicenseScanHelperThis is the helper class that provides Drivers License document scanning functionality.
EnrollmentsUtility class that helps BlockID SDK to determine what all types of Biometric (Pin, Live ID, device's biometric) and Digital (Drivers License, Passport, etc.) assets are supported for tenant. The Biometric and Digital assets registration is determined based on license module.
FIDO2KeyTypeEnum to define FIDO2 key type during FIDO2 Operations.
LiveIDScannerHelperThe LiveIDScannerHelper class is a helper class to work with Live ID feature.
LivenessFactorTypeAn enum to define different user expressions.
MessageGatewayModel class to hold MessageGateway data
NIDScanningSideAn enum to define the National ID document scanning order.
NationalIDScanHelperThis is the helper class that provides National ID document scanning functionality.
PassportScanHelperThis is the helper class that provides Passport document scanning functionality.
PersonalAssetsHelper class to check and determine if the type of personal assets are enabled for the tenant
ProxyDetailsModel class to hold proxy information.
QRScannerHelperThis is the helper class that provides QR scanning functionality.
TOTPUtility class to work with time-based OTP feature.
VersionAn enum to define and create access code version
WalletConnectHelperThis is the helper class that provides WalletConnect functionality
WorkstationAuthOriginModel class to represent the user's workstation authentication origin (attributes)

Error Handling Classes

Class NameSummary
AccountA structure to manage Account errors.
CustomErrorsA structure to manage various error codes and messages.
ErrorResponseA structure to manage error codes and messages response.
FIDO2A structure to manage various error codes and messages for FIDO2.
KYCA structure to manage various error codes and messages for KYC.
LicenseA structure to manage License errors.
NetworkA structure to manage various error codes and messages for Network.
PublicKeyA structure to manage various error codes and messages for PublicKey.
SCEPCheckA structure to manage SCEP Account errors.