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).
AnalyticsHelperThis class can report an events.
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.
CreateAccessCodePayloadThis class is used to represent the user CreateAccessCodePayload (properties).
DigitalAssetsHelper class to check and determine if the type of digital document assets are enabled for the tenant.
DocumentScanDelegateHelper class to handle the document scanning responses
DocumentScannerTypeAn enum to define document scanner type.
DocumentScannerViewControllerClass used to start the document scanner and give result back to the application.
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.
IPProviderThis class is designed to provide a mechanism for fetching and caching the user's IP address from a remote API.
LiveIDScannerHelperThe LiveIDScannerHelper class is a helper class to work with Live ID feature.
MessageGatewayModel class to hold MessageGateway data
OTPSeedUpdateActionAn enum to define OTP seed update action.
OTPSeedUpdatedAccountResultModel class to manage OTP Seed Updated Account Result.
PasskeyRequestModel class to hold Passkey Request (attributes).
PasskeyResponseModel class to hold Passkey Response (attributes).
PasswordRulesModel class to represent the password rules (attributes).
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.
RFIDResponseDelegateThis class can handle RFID passport scanning responses.
RFIDScannerHelperThis helper class can handle RFID scanning (E-Passport Chip).
TOTPUtility class to work with time-based OTP feature.
VersionAn enum to define and create access code version

Error Handling Classes​

Class NameSummary
AccountUtility to manage Account error codes and messages.
CaaSUtility to manage CaaS error codes and messages.
CustomErrorsUtility to manage various error codes and messages.
DocumentScannerUtility to manage error codes and messages for Document Scanner.
ErrorResponseUtility class to manage error response.
KYCUtility to manage KYC error codes and messages.
LiveIDSelfieUtility class to manage LiveIDSelfie errors.
LicenseUtility to manage License errors.
NetworkUtility to manage various error codes and messages for Network.
PasskeyUtility to manage various error codes and messages for passkeys.
PublicKeyUtility to manage various error codes and messages for PublicKey.
VCsUtility to manage VC error codes and messages.