BlockIDSDK

public class BlockIDSDK extends NSObject

---

This class is the entry point of BlockID SDK. This class is used to do the initial setup required for the SDK and to access all of its features.

Field Summary

Parameters
static BlockIDSDK	sharedInstance	Singleton instance of BlockIDSDK.

Method Summary

Parameters
void	addNativeAccount(method: String!, userId: String, password: String, origin: BIDOrigin, deviceToken: String? = nil, lon: Double, lat: Double, completion: @escaping UserAPICallback)	Add user account based on given userid and password.
void	addPreLinkedUser(userId: String, scep_hash: String, scep_privatekey: String, origin: BIDOrigin, account: BIDAccount?, completion: @escaping UserAPICallback)	Provides an option to add already linked user.
void	authenticateFIDO2Key(controller: UIViewController, userName: String, tenantDNS: String, communityName: String, type: FIDO2KeyType, fileName: String? = nil, completion: @escaping FIDO2Callback)	Provides the capability to authenticate FIDO2 security key
void	authenticateFIDO2Key(type: FIDO2KeyType, controller: UIViewController? = nil, sessionId: String?, sessionURL: String creds: String, scopes: String, lat: Double, lon: Double, origin: BIDOrigin, userId: String? = nil, metaData: [String: Any]? = nil, completion: @escaping AuthenticateUserCallback)	Provides the capability to authenticate FIDO2 security key using UWL 2.0
void	authenticateFIDO2Key(userName: String, tenantDNS: String, communityName: String, completion: @escaping Fido2Callback)	Provides the capability to authenticate FIDO2 security key.
void	authenticateUser(sessionId: String?, creds: String, dictScopes: [String: Any], lat: Double, lon: Double, origin: BIDOrigin, userId: String? = nil, completion: @escaping AuthenticateUserCallback)	Authenticate user with preset data (UWL1.0).
void	authenticateUser(sessionId: String?, sessionURL: String, creds: String, dictScopes: [String: Any], lat: Double, lon: Double, origin: BIDOrigin), userId: String? = nil, completion: @escaping AuthenticateUserCallback)	Authenticate user with preset data (UWL2.0).
void	authenticateUser(sessionId: String?, creds: String, scopes: String, lat: Double, lon: Double, origin: BIDOrigin, userId: String? = nil, extraData: [String: Any]? = nil, completion: @escaping AuthenticateUserCallback)	Authenticate user with scope (UWL1.0).
void	authenticateUser(controller: UIViewController? = nil, sessionId: String?, sessionURL: String creds: String, scopes: String, lat: Double, lon: Double, origin: BIDOrigin, userId: String? = nil, metaData: [String: Any]? = nil,extraData: [String: Any]? = nil, completion: @escaping AuthenticateUserCallback)	Authenticate user with scope (UWL2.0).
void	validateAccessCode(code: String, origin: BIDOrigin, completion: @escaping AccessCodeValidationAPICallback)	Check validity of access code. The access code validation is required during access code redemption process.
void	changeFido2PIN(oldPin: String, newPin: String, completion: @escaping FIDO2PINCallback)	Change FIDO2 PIN.
Bool	checkDeviceTrust()	Checks and indicates if the device is trusted.
void	commitApplicationWallet()	Commits the application wallet if tenant registration is successful.
String	decryptString(str: String, senderKey: String)	Performs decryption of data with the given public key.
String	encryptString(str: String, rcptKey: String)	Performs encryption of data with the given public key.
void	fetchDocuments(requestDict: [String: Any], _ completion: @escaping FetchDocumentsCallback)	Fetches and returns user documents from server.
void	fetchGlobalConfig(_ tenant: BIDTenant, completion: @escaping GlobalConfigCallback)	Fetch global configuration to find restorable accounts.
void	setPin(pin: String, proofedBy: String, completion: @escaping UserAPICallback)	Register Pin for login purpose.
BiometricAssets	getBiometricAssetEnrollments()	Returns registered biometric assets (Pin, Face ID / Touch ID, Live ID)
String	getDID()	Get DID of application. DID is a unique Distributed IDentifier.
DigitalAssets	getDigitalAssetEnrollments()	Returns list of all registered digital assets.
String	getIAL(completion: @escaping IALCallback)	Returns the current IAL (Identity Assurance Level) for the user.
(BIDLicense, ErrorResponse)	getLicense()	Returns the license module setup for the given tenant.
(BIDLinkedAccount, ErrorResponse)	getLinkedUserAccounts()	Returns a list of all the users linked to the given DID (Distributed Identifier).
UIImage	getLiveIDImage()	Returns the registered Live ID image of the user.
void	getMessageGateways(tenant: BIDTenant, completion: @escaping MessageGatewaysCallback)	Returns a list of available message gateways for the given tenant
String	getMnemonicPhrases()	Returns 12 Mnemonic Phrases. Used for future restoration of a wallet
String	getOfflineAuthPayload(bidLinkedAccount: BIDLinkedAccount)	Returns offline authentication payload.
ProxyDetails	getProxyDetails()	Returns proxy details.
String	getWalletPublicKey()	Returns application wallet public key.
([String: Any]?, ErrorResponse?)	getScopesAttributesDic(scopes: String, creds: String, origin: BIDOrigin, userId: String? = nil, completion: @escaping ([String: Any]?, ErrorResponse?) -> Void)	Returns user data based on defined scopes (e.g. firstName, ial, dl_object).
(BIDLinkedAccount?, ErrorResponse?)	getCurrentUserAccount()	Returns the selected user account.
String	getServerPublicKey()	Returns server public key of registered tenant.
void	getSessionResponse(completion: @escaping SessionResponseCallback)	Get session response for a particular session URL and sessionID.
(TOTP, ErrorResponse)	getTOTP()	Returns time based OTP value.
void	getVCsFrom(downloadURL url: String, completion: @escaping VCsCallback)	Returns VC data from download URL
void	getVP(_ dictVCObj: [String: Any], completion: @escaping VPCallback)	Returns VP object based on VC data }
String	getVersion()	Returns BlockID SDK version.
void	initiateTempWallet(completion: @escaping BIDWalletCreationCallback)	Initializes and creates temporary application wallet. The wallet contains DID, 12 Mnemonic Phrases, Public Key, and Private Key.
Bool	isAddressVerificationDone()	Checks if the address is verified. As of now, it always returns false.
Bool	isDeviceAuthRegistered()	Checks and indicates if user has setup biometric option for login purpose.
Bool	isDLEnrolled()	Checks and indicates if user has registered Drivers License.
Bool	isLiveIDRegistered()	Checks and indicates if user has registered Live ID.
Bool	isNationalIdEnrolled()	Checks and indicates if user has registered National ID.
Bool	isPassportEnrolled()	Checks and indicates if user has registered Passport.
Bool	isPinRegistered()	Checks and indicates if user has setup (registered) login Pin.
Bool	isReady()	Checks and indicates if the SDK is ready for use. BlockIDSDK must be ready before using any functions of SDK.
Bool	isRestoreModeOn()	Checks and indicates id the restore mode is set to true.
Bool	isSSNEnrolled()	Checks and indicates if the SSN (Social Security Number) is enrolled.
Bool	isTrustedSessionSources(sessionUrl: String)	Checks and indicates if the given session URL is trusted by BlockID SDK.
void	registeredocument(obj: [String: Any], liveIdProofedBy: String, docSignToken: String? = nil, faceImage: UIImage, liveIDSignToken: String? = nil, completion: @escaping UserAPICallback)	Store (add) the given document data along with Live ID.
void	registeredocument(obj: [String: Any], storeArtifacts: Bool, syncArtifacts: Bool, liveIdProofedBy: String, docSignToken: String? = nil, faceImage: UIImage, liveIDSignToken: String? = nil, completion: @escaping UserAPICallback)	Store (add) the given document data along with Live ID. This method must should be used IF you do not want to store and/or sync your document data on BlockID platform.
void	registeredocument(obj: [String: Any], sigToken: String? = nil, completion: @escaping UserAPICallback)	Store (add) the given document data.
void	registeredocument(obj: [String: Any], storeArtifacts: Bool, syncArtifacts: Bool, signToken: String? = nil, completion: @escaping UserAPICallback)	Store (add) the given document data. This method must should be used IF you do not want to store and/or sync your document data on BlockID platform.
void	registerFIDO2Key(controller: UIViewController, linkedAccount: BIDLinkedAccount?, type: FIDO2KeyType, completion: @escaping FIDO2Callback)	Provides the capability to register FIDO2 security key with BIDLinkedAccount
void	registerFIDO2Key(controller: UIViewController, userName: String, tenantDNS: String, communityName: String, type: FIDO2KeyType, pin: String? = nil, setPin: Bool = false, completion: @escaping FIDO2Callback)	Provides the capability to register FIDO2 security key.
void	registerFIDO2Key(userName: String, tenantDNS: String, communityName: String, fileName: String? = nil, completion: @escaping FIDO2Callback)	Provides the capability to register web-based FIDO2 security key.
void	registerTenant(tenant: BIDTenant, completion: @escaping BIDTenantRegisterationCallback)	Sets application tenant details in SDK. Tenant details must be set once. Make sure to register tenant call one time because tenant details are set only one time.
void	resetFido2PIN(completion: @escaping FIDO2PINCallback)	Reset FIDO2 security key.
void	resetPassword(userId: String, password: String, account: BIDAccount?, origin: BIDOrigin, completion: @escaping UserAPICallback)	Resets user password.
void	resetRestorationData()	Resets all restoration data.
void	resetSDK(licenseKey: String) -> Void	Purges the SDK wallet and all data stored/owned by the SDK.
void	restoreUserDataFromWallet(completion: @escaping UserAPICallback)	Performs user data restoration from application's wallet.
void	setDvcID(dvcID: String)	Sets application's dvcID (Document Verification Connector Identifier).
void	setFido2PIN(newPin: String, completion: @escaping FIDO2PINCallback)	Set FIDO2 PIN.
void	setLicenseKey(key: String)	Sets application's license key.
void	setLiveID(liveIdImage: UIImage , liveIdProofedBy: String? = nil, sigToken: String? = nil, completion: @escaping LiveIDCallback)	Register (store) user's Live ID data.
void	setProxy(host: String, port: Int, userName: String, password: String, isHTPPOnly: Bool)	Add proxy to all the outbound API calls used within the SDK.
void	setRestoreMode()	Sets user's account restore mode to true.
void	setCurrentUserAccount(account: BIDLinkedAccount)	Sets an user's linked account as currently selected account.
void	removePin(pin: String, completion: @escaping UserAPICallback)	Remove (delete) the existing Pin.
void	unLinkAccount(bidLinkedAccount: BIDLinkedAccount, deviceToken: String? = nil, completion: @escaping UserAPICallback)	Unlink the existing user account.
void	unregisteredocument(dictDoc: [String: Any], completion: @escaping UserAPICallback)	Remove (delete) the existing document.
void	updateAccountInfo(account: BIDLinkedAccount, pushID: String? = nil, deviceInfo: [String: Any], completion: @escaping UpdateAccInfoCallback)	This function is used to update unique origin with device pushID and deviceInfo to server to start getting push notifications after restoring data and accounts to a new device
void	verifyDocument(dvcID: String, dic: [String: Any], verifications: [String], completion: @escaping ((Bool, [String: Any]?, ErrorResponse?) -> Void))	Verify document data (that the user has presented) through our partners.
void	verifyLiveID(image: UIImage, sigToken: String? = nil, completion: @escaping LiveIDCallback)	Verify Live ID.
Bool	verifyPin(pin: String)	Returns if the given is verified.

Method Detail

addNativeAccount

public func addNativeAccount(method: String!, userId: String, password: String, origin: BIDOrigin, deviceToken: String? = nil, lon: Double, lat: Double, completion: @escaping UserAPICallback)

• Add user account based on given userid and password.

Parameters
method	String	Method type to add account.
userId	String	UserID of user's account.
password	String	Password of user's account.
origin	BIDOrigin	Origin details.
deviceToken	String	Push token of user's device. Use for sending push notifications.
lon	String	Longitude of user's location.
lat	String	Latitude of user's location.
completion	UserAPICallback	The block to execute after the response is received.

---

addPreLinkedUser

public func addPreLinkedUser(userId: String, scep_hash: String, scep_privatekey: String, origin: BIDOrigin, account: BIDAccount?, completion: @escaping UserAPICallback)

• Provides an option to add already linked users.

Parameters
userId	String	UserID of user's account.
scep_hash	String	Scep hash value.
scep_privatekey	String	Scep private key.
scep_expiry	String	Scep expiry.
origin	BIDOrigin	User account origin details.
account	BIDAccount	An object of BIDAccount.
callback	UserAPICallback	The block to execute after the response is received.

---

authenticateFIDO2Key

public func authenticateFIDO2Key(controller: UIViewController, userName: String, tenantDNS: String, communityName: String, type: FIDO2KeyType, fileName: String? = nil, completion: @escaping FIDO2Callback)

• Provides the capability to authenticate FIDO2 security key.

Parameter
controller	UIViewController: The UIViewController object uses to set up user consent UI.
userName	String: The user name which requires authentication.
tenantDNS	String: The tenant DNS against which the user is authenticated.
communityName	String: The community name against which the user is authenticated.
communityName	String: The community name against which the user is authenticated.
type	FIDO2KeyType: FIDO2 key type.
completion	FIDO2Callback: The block to execute after the response is received.

---

authenticateFIDO2Key

public func authenticateFIDO2Key(type: FIDO2KeyType, controller: UIViewController? = nil, sessionId: String?, sessionURL: String creds: String, scopes: String, lat: Double, lon: Double, origin: BIDOrigin, userId: String? = nil, metaData: [String: Any]? = nil, completion: @escaping AuthenticateUserCallback)

• Provides the capability to authenticate FIDO2 security key using UWL 2.0.

Parameter
type	FIDO2KeyType: Current FIDO2 key type
controller	UIViewController: Current UIViewController object
sessionId	String: Session for authentication.
sessionUrl	String: Complete session URL containing sessionId.
creds	String: Credential of user account.
scopes	String: Scopes defined for authentication
lat	Double: Latitude of user location.
lon	Double: Longitude of user location.
origin	BIDOrigin: Origin details of the user.
userId	String: UserID of user account.
metaData	[String: Any]: Dictionary object for FIDO2 sign-in
completion	AuthenticateUserCallback: The block to execute after the response is received.

---

authenticateFIDO2Key

public func authenticateFIDO2Key(userName: String, tenantDNS: String, communityName: String, fileName: String? = nil, completion: @escaping FIDO2Callback)

• Provides the capability to authenticate web-based FIDO2 security key.

Parameters
userName	String: The user name which requires authentication.
tenantDNS	String: The tenant DNS against which the user is authenticated.
communityName	String: The community name against which the user is authenticated.
fileName	String: The HTML file name.
completion	FIDO2Callback: The block to execute after the response is received.

---

authenticateUser

public func authenticateUser(sessionId: String?, creds: String, dictScopes: [String: Any], lat: Double, lon: Double, origin: BIDOrigin, userId: String? = nil, completion: @escaping AuthenticateUserCallback)

• Authenticate user with preset data (UWL1.0).

Parameter
sessionId	String: Session for authentication.
creds	String: Credential of user's account.
dictScopes	Dictionary: Authentication data.
lat	Double: Latitude of user's location.
lon	Double: Longitude of user's location.
origin	BIDOrigin: Origin details of user.
userId	String: UserID of user's account.
completion	AuthenticateUserCallback: The block to execute after the response is received.

---

authenticateUser

public func authenticateUser(sessionId: String?, sessionURL: String, creds: String, dictScopes: [String: Any], lat: Double, lon: Double, origin: BIDOrigin, userId: String? = nil, completion: @escaping AuthenticateUserCallback)

• Authenticate user with preset data (UWL2.0).

Parameter
sessionId	String: Session for authentication.
sessionUrl	String: Complete session URL containing sessionId.
creds	String: Credential of user's account.
dictScopes	Dictionary: Authentication data.
lat	Double: Latitude of user's location.
lon	Double: Longitude of user's location.
origin	BIDOrigin: Origin details of user.
userId	String: UserID of user's account.
completion	AuthenticateUserCallback: The block to execute after the response is received.

---

authenticateUser

public func authenticateUser(sessionId: String?, creds: String, scopes: String, lat: Double, lon: Double, origin: BIDOrigin, userId: String? = nil, extra data: [String: nil]? = nil, completion: @escaping AuthenticateUserCallback)

• Authenticate user with scope (UWL1.0).

Parameter
sessionId	String: Session for authentication.
creds	String: Credential of user's account.
scopes	String: Scopes defined for authentication
lat	Double: Latitude of user's location.
lon	Double: Longitude of user's location.
origin	BIDOrigin: Origin details of user.
userId	String: UserID of user's account.
extraData	[String: Any]:Dictionary object
completion	AuthenticateUserCallback: The block to execute after the response is received.

---

authenticateUser

public func authenticateUser(type: FIDO2KeyType, controller: UIViewController? = nil, sessionId: String?, sessionURL: String creds: String, scopes: String, lat: Double, lon: Double, origin: BIDOrigin, userId: String? = nil, metaData: [String: Any]? = nil, completion: @escaping AuthenticateUserCallback)

• Authenticate user with scope (UWL2.0).

Parameter
type	FIDO2KeyType: Current
controller	UIViewController: Current UIViewController object
sessionId	String: Session for authentication.
sessionUrl	String: Complete session URL containing sessionId.
creds	String: Credential of user's account.
scopes	String: Scopes defined for authentication
lat	Double: Latitude of user's location.
lon	Double: Longitude of user's location.
origin	BIDOrigin: Origin details of user.
userId	String: UserID of user's account.
metaData	[String: Any]:Dictionary object to FIDO sign in
extraData	[String: Any]:Dictionary object
completion	AuthenticateUserCallback: The block to execute after the response is received.

---

changeFIDO2PIN

public func changeFido2PIN(oldPin: String, newPin: String, completion: @escaping FIDO2PINCallback)

• Change FIDO2 PIN

Parameter
oldPIN	String: oldPiN
newPIN	String: newPin
completion	FIDO2PINCallback: The block to execute after the response is received.

---

checkDeviceTrust

public func checkDeviceTrust() -> Bool

• Checks and indicates if the device is trusted.

---

commitApplicationWallet

public func commitApplicationWallet()

• Commits the application's wallet IFF tenant registration is successful.

---

decryptString

public func decryptString(str: String, senderKey: String) -> String?

• Performs decryption of data with the given public key.

Parameters
str	String	Data to decrypt.
senderKey	String	Public key used to decrypt the data.

---

encryptString

public func encryptString(str: String, rcptKey: String) -> String?

• Performs encryption of data with the given public key.

Parameters
inputData	String	Data to encrypt.
senderKey	String	Public key used to encrypt the data.

---

fetchDocuments

public func fetchDocuments(requestDict: [String: Any], _ completion: @escaping FetchDocumentsCallback)

• Fetches & returns user documents from server

Parameter
requestDict	[String: Any]: Dictionary of document ids.
completion	FetchDocumentsCallback: Callback that returns documents dictionary.

Request Dictionary Parameter
categories	[String]: Document category to fetch (ex. identity_document, misc_document)
id	[String]: Document ID to fetch
type	[String]: Document Type to fetch (ex. dl, ppt, nationalid, ssn)
metadataOnly	bool true: Get metadata only false: Get metadata and actual document data Example metadata: { "type": "dl", "id": "12345", "proofedBy": "blockid", "category": "identity_document", "doe": "20001029", "proofs": ["any proof if present"] }

---

fetchGlobalConfig

public func fetchGlobalConfig(_ tenant: BIDTenant, completion: @escaping GlobalConfigCallback)

• Fetch global configuration to find restorable accounts.

Parameter
tenant	BIDTenant: Object of BIDTenant.
completion	GlobalConfigCallback: Callback that returns global configuration.

---

setPin

public func setPin(pin: String, proofedBy: String, completion: @escaping UserAPICallback) -> Void

• Register Pin for login purposes.

Parameters
pin	String	Pin to enroll (register)
proofedBy	String	This identifies the entity responsible for proofing. The default value is "blockid"
completion	UserAPICallback	The block to execute after the response is received.

---

getBiometricAssetEnrollments

public func getBiometricAssetEnrollments() -> BiometricAssets?

• Returns registered biometric assets (Pin, Face ID / Touch ID, Live ID)

---

getDID

public func getDID() -> String

• Get DID of application. DID is a unique Distributed IDentifier.

---

getDigitalAssetEnrollments

public func getDigitalAssetEnrollments() -> DigitalAssets?

• Returns list of all registered digital assets.

---

getIAL

public func getIAL(completion: @escaping IALCallback) → Void

• Get the current IAL (Identity Assurance Level) of the user.

---

getLicense

public func getLicense() -> (license: BIDLicense?, error: ErrorResponse?)

• Returns license modules set up for a given tenant.

---

getLinkedUserAccounts

public func getLinkedUserAccounts() -> (linkedUsers: [BIDLinkedAccount]?, error: ErrorResponse?)

• Returns a list of all users linked to DID (Distributed Identifier).

---

getLiveIDImage

public func getLiveIDImage() -> UIImage?

• Returns registered Live ID image of the user

---

getMessageGateways

public func getMessageGateways(tenant: BIDTenant, completion: @escaping MessageGatewaysCallback) -> Void

• Get list of message gateway available for given tenant.

Parameters
tenant	BIDTenant	Tenant details
completion	MessageGatewaysCallback	The block to execute after the response is received

---

getMnemonicPhrases

public func getMnemonicPhrases() -> String?

• Returns 12 Mnemonic Phrases. Used for the restoration of a wallet in the future.

---

getOfflineAuthPayload

public func getOfflineAuthPayload(bidLinkedAccount: BIDLinkedAccount) -> String?

• Returns offline authentication payload.

Parameters
bidLinkedAccount	BIDLinkedAccount	Linked user's account.

---

getProxyDetails

public func getProxyDetails() -> ProxyDetails?

• Returns proxy details.

---

getWalletPublicKey

public func getWalletPublicKey() -> String

• Returns the application wallet's public key.

---

getScopesAttributesDic

public func getScopesAttributesDic(scopes: String, creds: String, origin: BIDOrigin, userId: String? = nil, completion: @escaping ([String: Any]?, ErrorResponse?) -> Void) Returns user's data based on defined scopes (e.g. firstName, ial, dl_object).

Parameters
scopes	String: Comma separated scopes.
creds	String: User's credentials.
origin	BIDOrigin: Origin details of user.
userId	String: UserID of user account.
completion	Dictionary, ErrorResponse: [String: Any], ErrorResponse

---

getCurrentUserAccount

public func getCurrentUserAccount() -> (currentUser: BIDLinkedAccount?, error: ErrorResponse?)

• Returns the selected user account.

---

getServerPublicKey

public func getServerPublicKey() -> String

• Returns server public key of a registered tenant.

---

getSessionResponse

public func getSessionResponse(completion: @escaping SessionResponseCallback)

• Get session response for a particular session URL and sessionID.

Parameters
completion	SessionResponseCallback	The block to execute after the response is received.

---

getTOTP

public func getTOTP() -> (totp: TOTP?, error: ErrorResponse?)

• Returns time-based OTP value.

---

getVCsFrom

---

public func getVCsFrom(downloadURL url: String, completion: @escaping VCsCallback)

• Returns VC data from download URL

Parameters
downloadURL	String: Download URL.
completion	VCsCallback: The block to execute after the response is received.

---

getVP

---

public func getVP(_ dictVCObj: [String: Any], completion: @escaping VPCallback)

• Returns VP object based on VC data

Parameters
vcData	dictVCObj: VC Data for which VP has to be created
completion	VPCallback: The block to execute after the response is received.

---

getVersion

public func getVersion() -> String?

• Returns BlockID SDK version.

---

initiateTempWallet

public func initiateTempWallet(completion: @escaping BIDWalletCreationCallback)

• Initializes and creates a temporary application wallet. The wallet contains DID, 12 Mnemonic Phrases, Public Key, and Private Key.

---

isAddressVerificationDone

public func isAddressVerificationDone() -> Bool

• Checks if the address is verified. As of now, it always returns false.

---

isDeviceAuthRegistered

public func isDeviceAuthRegistered() -> Bool

• Checks and indicates if the user has set up a biometric option for login purposes.

---

isDLEnrolled

public func isDLEnrolled() -> Bool

• Checks and indicates if the user has a registered Drivers License.

---

isLiveIDRegistered

public func isLiveIDRegistered() -> Bool

• Checks and indicates if the user has registered Live ID.

---

isNationalIdEnrolled

public func isNationalIdEnrolled() -> Bool

• Checks and indicates if the user has registered National ID.

---

isPassportEnrolled

public func isPassportEnrolled() -> Bool

• Checks and indicates if the user has registered a Passport.

---

isPinRegistered

public func isPinRegistered() -> Bool

• Checks and indicates if the user has set up (registered) login Pin.

---

isReady

public func isReady() -> Bool

• Checks and indicates if the SDK is ready for use. BlockIDSDK must be ready before using any functions of SDK.

---

isRestoreModeOn

public func isRestoreModeOn() -> Bool

• Checks and indicates if the restore mode is set to true.

---

isSSNEnrolled

public func isSSNEnrolled() -> Bool

• Checks and indicates if the SSN (Social Security Number) is enrolled.

---

isTrustedSessionSources

public func isTrustedSessionSources(sessionUrl: String) -> Bool

• Checks and indicates if the given session URL is trusted by BlockID SDK.

Parameters
sessionUrl	String	Session URL to be verified from a list of a trusted sources.

---

registeredocument

public func registeredocument(obj: [String: Any], liveIdProofedBy: String, docSignToken: String? = nil, faceImage: UIImage, liveIDSignToken: String? = nil, completion: @escaping UserAPICallback)

• Store (add) the given document data along with Live ID.

Parameters
obj	Dictionary	Document data to be stored.
storeArtifacts	Bool	Flag to indicate if the document must be stored in local storage.
syncArtifacts	Bool	Flag to indicate if the document must be synced with IPFS on BlockID platform.
liveIdProofedBy	String	The entity responsible for proofing the Live ID (selfie). For the BlockID Live ID (selfie) scanner, the default value is "blockid".
docSignToken	String	Signature token of the document to verify if the document data is modified or not.
faceImage	UIImage	Live ID image to be stored.
liveIDSignToken	String	Signature token of Live ID to verify if the Live ID is modified or not.
completion	UserAPICallback	The block to execute after the response is received.

---

registeredocument

public func registeredocument(obj: [String: Any], storeArtifacts: Bool, syncArtifacts: Bool, liveIdProofedBy: String, docSignToken: String? = nil, faceImage: UIImage, liveIDSignToken: String? = nil, completion: @escaping UserAPICallback)

• Store (add) the given document data along with Live ID. This method must be used IF you do not want to store and/or sync your document data on the BlockID platform.

Parameters
obj	Dictionary	Document data to be stored.
storeArtifacts	Bool	Flag to indicate if the document must be stored in local storage.
syncArtifacts	Bool	Flag to indicate if the document must be synced with IPFS on the BlockID platform.
liveIdProofedBy	String	The entity responsible for proofing the Live ID (selfie). For the BlockID Live ID (selfie) scanner, the default value is "blockid".
docSignToken	String	Signature token of the document to verify if the document data is modified or not.
faceImage	UIImage	Live ID image to be stored.
liveIDSignToken	String	Signature token of Live ID to verify if the Live ID is modified or not.
completion	UserAPICallback	The block to execute after the response is received.

---

registeredocument

public func registeredocument(obj: [String: Any], sigToken: String? = nil, completion: @escaping UserAPICallback)

• Store (add) the given document data.

Parameters
obj	Dictionary	Document data to be stored.
sigToken	String	Signature token of the document to verify if the document data is modified or not.
completion	UserAPICallback	The block to execute after the response is received.

---

registeredocument

public func registeredocument(obj: [String: Any], storeArtifacts: Bool, syncArtifacts: Bool, signToken: String? = nil, completion: @escaping UserAPICallback)

• Store (add) the given document data. This method must be used IF you do not want to store and/or sync your document data on the BlockID platform.

Parameters
obj	Dictionary	Document data to be stored.
storeArtifacts	Bool	Flag to indicate if the document must be stored in local storage.
syncArtifacts	Bool	Flag to indicate if the document must be synced with IPFS on the BlockID platform.
sigToken	String	Signature token of the document to verify if the document data is modified or not.
completion	UserAPICallback	The block to execute after the response is received.

---

registerFIDO2Key

public func registerFIDO2Key(controller: UIViewController, linkedAccount: BIDLinkedAccount?, type: FIDO2KeyType, completion: @escaping FIDO2Callback)

• Provides the capability to register FIDO2 security key with BIDLinkedAccount.

Parameter
controller	UIViewController: Current controller.
linkedAccount	BIDLinkedAccount: account object to be registered.
type	FIDO2KeyType: Current fido key type.
completion	FIDO2Callback: The block to execute after the response is received.

---

registerFIDO2Key

public func registerFIDO2Key(controller: UIViewController, userName: String, tenantDNS: String, communityName: String, type: FIDO2KeyType, pin: String? = nil, completion: @escaping FIDO2Callback)

• Provides the capability to register FIDO2 security key.

Parameter
controller	UIViewController: Current controller.
userName	String: The user name which requires to be registered.
tenantDNS	String: The tenant's DNS against which the user is registered.
communityName	String: The community name against which the user is registered.
type	FIDO2KeyType: Current fido key type.
pin	String: PIN of the device to be used for authentication.
setPin	Bool: Set PIN during FIDO2 registration or not
completion	FIDO2Callback: The block to execute after the response is received.

---

registerFIDO2Key

public func registerFIDO2Key(userName: String, tenantDNS: String, communityName: String, fileName: String? = nil, completion: @escaping FIDO2Callback)

• Provides the capability to register web based FIDO2 security key.

Parameter
userName	String: The user name which requires to be registered.
tenantDNS	String: The tenant's DNS against which the user is registered.
communityName	String: The community name against which the user is registered.
fileName	String: The HTML file name.
completion	FIDO2Callback: The block to execute after the response is received.

---

registerTenant

public func registerTenant(tenant: BIDTenant, completion: @escaping BIDTenantRegisterationCallback)

• Sets application tenant details in SDK. Tenant details must be set once. Make sure to register tenant call one time because tenant details are set only one time.

Parameters
tenant	BIDTenant	Tenant details.
callback	BIDTenantRegisterationCallback	The block to execute after the response is received.

---

resetPassword

public func resetPassword(userId: String, password: String, account: BIDAccount?, origin: BIDOrigin, completion: @escaping UserAPICallback)

• Resets user's password.

Parameters
userID	String	Userid of user's account.
password	String	Current password of user's account.
account	BIDAccount	User's account for which password reset is required.
origin	BIDOrigin	Origin details of user's account.
completion	UserAPICallback	The block to execute after the response is received.

---

resetRestorationData

public func resetRestorationData()

• Resets all restoration data.

---

resetSDK

public func resetSDK(licenseKey: String) -> Void

• Purges the SDK wallet and all data stored/owned by the SDK.

Parameters
licenseKey	String	application's license key.

---

restoreUserDataFromWallet

public func restoreUserDataFromWallet(completion: @escaping UserAPICallback)

• Performs user data restoration from the application's wallet.

Parameters
accountRestoreListener	UserAPICallback	The block to execute after the response is received

---

setDvcID

public func setDvcID(dvcID: String)

• Sets application's dvcID (Document Verification Connector Identifier).

Parameters
dvcId	String	Application's dvcID (Document Verification Connector Identifier).

---

setFIDO2PIN

public func setFido2PIN(newPin: String, completion: @escaping FIDO2PINCallback)

• Set FIDO2 PIN

Parameter
newPin	String: New Pin.
completion	FIDO2PINCallback: The block to execute after the response is received.

---

setLicenseKey

public func setLicenseKey(key: String)

• Sets application's license key.

Parameters
key	String	application license key.

---

setLiveID

public func setLiveID(liveIdImage: UIImage , liveIdProofedBy: String? = nil, sigToken: String? = nil, completion: @escaping LiveIDCallback)

• Register (store) the user's Live ID data.

Parameters
liveIdImage	UIImage	Live ID (Selfie) image.
liveIdProofedBy	String	The entity responsible for proofing the Live ID (selfie). For the BlockID Live ID (selfie) scanner, the default value is "blockid".
sigToken	String	Signature token to verify if the Live ID (selfie) data is modified or not.
completion	LiveIDCallback	The block to execute after the response is received.

---

setProxy

public func setProxy(host: String, port: Int, userName: String, password: String, isHTPPOnly: Bool)

• Add proxy to all the outbound API calls used within the SDK.

Parameters
host	String	The hostname associated with the HTTP proxy.
port	Int	The port number associated with the HTTP proxy.
userName	String	The username to be used with the proxy.
password	String	The password to be used with the proxy.
isHTPPOnly	Bool	Indicates if the proxy runs on HTTP server.

---

setRestoreMode

public func setRestoreMode()

• Sets user's account restore mode to true.

---

setCurrentUserAccount

public func setCurrentUserAccount(account: BIDLinkedAccount)

• Sets a user's linked account as the currently selected account.

Parameters
account	BIDLinkedAccount	User's linked account.

---

removePin

public func removePin(pin: String, completion: @escaping UserAPICallback)

• Remove (delete) the existing Pin.

Parameters
pin	String	Pin to be removed.
completion	UserAPICallback	The block to execute after the response is received.

---

resetFIDO2PIN

public func resetFido2(completion: @escaping FIDO2PINCallback)

• Reset FIDO2 Security key

Parameter
completion	FIDO2PINCallback: The block to execute after the response is received.

---

unLinkAccount

public func unLinkAccount(bidLinkedAccount: BIDLinkedAccount, deviceToken: String? = nil, completion: @escaping UserAPICallback)

• Unlink the existing user account.

Parameters
bidLinkedAccount	BIDLinkedAccount	Currently linked user account.
deviceToken	String	PushID (push token) of device.
completion	UserAPICallback	The block to execute after the response is received.

---

unregisterDocument

public func unregistereDocument(dictDoc: [String: Any], completion: @escaping UserAPICallback)

• Remove (delete) the existing document.

Parameters
dictDoc	Dictionary	Document to be removed.
completion	UserAPICallback	The block to execute after the response is received.

---

validateAccessCode

public func validateAccessCode(code: String, origin: BIDOrigin, completion: @escaping AccessCodeValidationAPICallback)

• Check the validity of the access code. Access code validation is required during the access code redemption process.

Parameters
code	String	Access code to be validated.
origin	BIDOrigin	Tenant tag.
completion	AccessCodeValidationAPICallback	The block to execute after the response is received.

---

updateAccountInfo

public func updateAccountInfo(account: BIDLinkedAccount, pushID: String? = nil, deviceInfo: [String: Any], completion: @escaping UpdateAccInfoCallback)

• This function updates the unique origin with device pushID and deviceInfo to the server to start getting push notifications after restoring data and accounts to a new device.

Parameter
account	BIDLinkedAccount: Account details which used to update unique origin.
pushID	String: iOS device push id/token.
deviceInfo	[String: Any]: Device Information. Device Information: uid: String // Unique uuid of device os: String // Android | iOS deviceName: String // Device name authenticatorId: String // Mobile app's bundle id authenticatorVersion: String // Mobile app's version authenticatorName: String // Mobile app's name clientIp: String // Device IP address userAgent: String // Device user agent locLat: double // Device latitude locLon: double // Device longitude
completion	UpdateAccInfoCallback: Callback after the request is executed.

---

verifyDocument

public func verifyDocument(dvcID: String, dic: [String: Any], verifications: [String], completion: @escaping ((Bool, [String: Any]?, ErrorResponse?) -> Void))

• Verify document data (that the user has presented) through our partners.

Parameters
dvcID	String	Document Verification Connector Identifier.
dic	Dictionary	Dictionary of document data.
verifications	String[]	List of verification.
completion	((Bool, [String: Any]?, ErrorResponse?) -> Void)	The block to execute after the response is received.

---

verifyLiveID

public func verifyLiveID(image: UIImage, sigToken: String? = nil, completion: @escaping LiveIDCallback)

• Verify Live ID.

Parameters
image	UIImage	Bitmap to compare with enrolled Live ID (selfie).
sigToken	String	Signature token of Live ID
completion	LiveIDCallback	The block to execute after the response is received.

---

verifyPin

public func verifyPin(pin: String) -> Bool

• Returns if the given is verified.

Parameters
pin	String	Current Pin for verification.

---

Typealias

Parameters
AccessCodeValidationAPICallback	(Bool, ErrorResponse, AccessCodeValidationResponseDecryptedData) -> Void	Indicates when the access code validation response is received.
AuthenticateUserCallback	(Bool, String, ErrorResponse) -> Void	Indicates when user authentication response is received.
BIDMigrationCallback	(Bool, ErrorResponse) -> Void	Indicates when the migration activity is completed.
BIDTenantRegisterationCallback	(Bool, ErrorResponse, BIDTenant) -> Void	Indicates when the tenant registration is completed.
BIDWalletCreationCallback	(Bool, ErrorResponse) -> Void	Indicates when the wallet creation is completed.
FetchDocumentsCallback	(_ status: Bool, _ responseDict: [String: Any]?, _ error: ErrorResponse?) -> Void	Callback that returns documents dictionary.
FIDO2Callback	(_ status: Bool, _ error: ErrorResponse?) -> Void	Indicates when the FIDO2 operation (registration / authentication) is completed.
FIDO2PINCallback	(_ status: Bool, _ error: ErrorResponse?) -> Void	Indicates when the FIDO2 operation (set pin/ change pin/ reset FIDO2) is completed.
GlobalConfigCallback	(_ status: Bool, _ error: ErrorResponse?, _ response: GlobalConfigResponse?) -> Void	Callback that returns global configuration.
IALCallback	((_ status: Bool, _ ialValue: String, _ error: ErrorResponse?) -> Void)	Indicates when the IAL operation is completed.
KYCCallback	(_ status: Bool, _ kycHash: String?, _ error: ErrorResponse?) -> Void	Indicates when the KYC operation is completed.
LiveIDCallback	(Bool, ErrorResponse) -> Void	Indicates when the Live ID scanning response is received.
MessageGatewaysCallback	(_ status: Bool, _ object: [MessageGateway]?, _ error: ErrorResponse?) -> Void	Indicates when the list of message gateway response is received.
PasswordPolicyCallback	(_ status: Bool, _ response: BIDPasswordPolicy?, _ error: ErrorResponse?)	Call back listener to return response once API execution completes.
SessionResponseCallback	(Bool, SessionResponseData, ErrorResponse) -> Void	Indicates when the session response is received.
UpdateAccInfoCallback	(_ status: Bool, _ error: ErrorResponse?) -> Void	Callback that gives status after the request is executed.
UserAPICallback	(Bool, ErrorResponse) -> Void	Indicates when the User API response is received.
VCsCallback	((_ status: Bool, _ error: ErrorResponse?, _ response: String?) -> Void)	Callback for event when VC data is received.
VPCallback	((_ status: Bool, _ error: ErrorResponse?, _ response: String?) -> Void)	Callback for event when VP data is received.