BlockIDSDK

public class BlockIDSDK extends Object

↳ package com.onekosmos.blockid.sdk

---

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

Constant Summary

type	parameter
String	K_WALLET_CREATION
String	K_MESSAGE
String	K_WALLET_GENERATED
String	K_WALLET_GENERATION_FAILED

Method Summary

name	type	parameter	summary
addNativeAccount	void	addNativeAccount(String pushId, String userID, String password, BIDOrigin bidOrigin, String versionName, String lat, String lon, AddScepAccountCallback addScepAccountCallback)	Add user account based on given userid and password
addPreLinkedUser	void	addPreLinkedUser(String userId, String scep_hash, String scep_privatekey, BIDOrigin origin, BIDAccount account, LinkUserCallback callback)	Provides an option to add already linked user
authenticateFIDO2Key	void	authenticateFIDO2Key(@NonNull Activity activity, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @NonNull FIDO2Callback callback)	Provides the capability to authenticate Web BasedFIDO2 security key.
authenticateFIDO2Key	void	authenticateFIDO2Key(@NonNull Activity activity, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @Nullable String fileName, @NonNull FIDO2Callback callback)	Provides the capability to authenticate Web Based FIDO2 security key with Custom HTML.
authenticateFIDO2Key	void	authenticateFIDO2Key(@NonNull Context context, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @NonNull FIDO2KeyType type, FIDO2Observer observer, @NonNull FIDO2Callback callback)	Provides the capability to authenticate Native FIDO2 security key
authenticateFIDO2Key	void	authenticateFIDO2Key(@NonNull Context context, @NonNull FIDO2KeyType type, FIDO2Observer observer, @Nullable String userId, @NonNull String sessionID, @NonNull String sessionUrl, String scopes, LinkedHashMap<String, Object> metadata, String creds, @NonNull BIDOrigin origin, String latitude, String longitude, String versionName, @NonNull FIDO2Callback callback)	Provides the capability to authenticate NativeFIDO2 security key with Linked Account
authenticateUser	void	authenticateUser(@Nullable String userId, String sessionId, LinkedHashMap<String, Object> dataObject, String creds, BIDOrigin bidOrigin, String latitude, String longitude, String versionName, AuthenticateUserCallback authenticateUserCallback)	Authenticate user with preset data (UWL1.0)
authenticateUser	void	authenticateUser(@Nullable String userId, String sessionId, String sessionUrl, LinkedHashMap<String, Object> dataObject, String creds, BIDOrigin bidOrigin, String latitude, String longitude, String versionName, AuthenticateUserCallback authenticateUserCallback)	Authenticate user with preset data (UWL2.0)
authenticateUser	void	authenticateUser(@NonNullContext context, @Nullable String userId, String sessionId, String scopes, String creds, BIDOrigin bidOrigin, String latitude, String longitude, String versionName, HashMap<String, Object> extraData, AuthenticateUserCallback callback)	Authenticate user with scope (UWL1.0)
authenticateUser	void	authenticateUser(@NonNullContext context, @Nullable String userId, String sessionId, String sessionUrl, String scopes, LinkedHashMap<String, Object> metadata, String creds, BIDOrigin bidOrigin, String latitude, String longitude, String versionName, HashMap<String, Object> extraData, AuthenticateUserCallback callback)	Authenticate user with scope (UWL2.0)
checkDeviceFingerPrintEnabled	BIDGenericResponse	checkDeviceFingerPrintEnabled()	Checks if fingerprint is enabled on device
checkIfADRequired	void	checkIfADRequired(String code, String tag, String api, String community, IADValidationCallback adValidationCallback)	Check validity of access code. The access code validation is required during access code redemption process
checkIfDeviceIsSecured	BIDGenericResponse	checkIfDeviceIsSecured()	Checks and indicates if keyguard security is enabled in phone device
checkSCEPCertificate	void	checkSCEPCertificate(BIDLinkedAccount requestedAccount, SCEPCertificateCallback callback)	Check to see if the SCEP certificate linked to the account is expired, and renews certiticate if expired
commitApplicationWallet	void	commitApplicationWallet()	Commits the application's wallet if tenant registration is successful
commitRestorationData	void	commitRestorationData()	Commits the application's restoration data
CreateAccessCode	void	createAccessCode(CreateAccessCodePayload emailPayload, AccessCodeCallback accessCodeCallback)	Create access for email verification
decryptString	String	decryptString(String inputData, String senderKey)	Performs decryption of data with the given public key
encryptString	String	encryptString(String inputData, String rcptKey)	Performs encryption of data with the given public key
enrollPin	void	enrollPin(String pin, String proofedBy, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)	Register pin for login purpose
fetchDocuments	void	fetchDocuments(HashMap<String, Object> requestMap, FetchDocumentsCallback callback)	Fetches and returns user documents from server
fetchGlobalConfig	void	fetchGlobalConfig(@NonNull BIDTenant tenant, GlobalConfigCallback callback)	Fetches and returns Global Config
generateNewSession	void	generateNewSession(BIDOrigin origin, String authType, String scopes, GenerateNewSessionListener generateNewSessionListener)	Generate new session
getBiometricAssetEnrollments	Enrollments.BiometricAssets	getBiometricAssetEnrollments()	Returns an instance of BiometricAssets class
getDID	String	getDID()	Get DID of application. DID is a unique Distributed IDentifier
getDigitalAssetEnrollments	Enrollments.DigitalAssets	getDigitalAssetEnrollments()	Returns an instance of DigitalAssets
getIAL	void	getIAL(IALCallback callback)	Returns the current IAL (Identity Assurance Level) of user
getInstance	static BlockIDSDK	getInstance()	Returns an instance of BlockIDSDK
getKYC	void	getKYC(KYCCallback callback)	Get KYC hash
getLicenseModule	BIDGenericResponse	getLicenseModule()	Returns license modules setup for given tenant
getLinkedUserList	BIDGenericResponse	getLinkedUserList()	Returns list of all users linked to DID (Distributed IDentifier)
getLiveIdImage	BIDGenericResponse	getLiveIdImage()	Returns registered Live ID image of user
getMessageGateways	void	getMessageGateways(@NonNull BIDTenant tenant, MessageGatewaysCallback callback)	Returns list of message gateways available for given tenant
getMnemonic	List<String>	getMnemonic()	Returns 12 Mnemonic Phrases. Used for the restoration of a wallet in the future
getOfflineAuthPayload	BIDGenericResponse	getOfflineAuthPayload(BIDLinkedAccount bidLinkedAccount)	Returns offline authentication payload
getPersonalAssetEnrollments	Enrollments.PersonalAssets	getPersonalAssetEnrollments()	Returns an instance of PersonalAssets class
getPasswordPolicy	Enrollments.PersonalAssets		getPasswordPolicy(@NonNull BIDLinkedAccount account, @NonNull PasswordPolicyCallback callback)
getProxyDetails	ProxyDetails	getProxyDetails()	Returns proxy details
getPublicKey	String	getPublicKey()	Returns application wallet's public key
getScopes	void	getScopes(String userId, String scopes, String creds,BIDOrigin bidorigin, String lat, String longitude, GetScopeCallback callback)	Returns user's data based on defined scopes (e.g. firstName, ial, dl_object)
getSelectedAccount	BIDGenericResponse	getSelectedAccount()	Returns the selected user account
getServerPublicKey	String	getServerPublicKey()	Returns server public key of registered tenant
getSessionResponse	void	getSessionResponse(String sessionURL, String sessionId, GetNewSessionListener getNewSessionListener)	Get session response for given session URL and sessionID
getTenant		BIDTenant	getTenant()
getTOTP	BIDGenericResponse	getTOTP()	Returns time based OTP value
getTOTP	BIDGenericResponse	getTOTP(String otpSeed)	Returns time based OTP value based on given OTP seed
getVC	void	getVC(@NonNull String downloadURL, @NonNull VCCallback callback)	Returns VC data from download URL
getVersion	String	getVersion()	Returns BlockID SDK version
getVP	void	getVP(JSONObject vcData, VPCallback callback)	Returns VP object based on VC data
initialize	static void	initialize(Context context)	Initializes and creates an instance of BlockIDSDK
initiateWallet	void	initiateWallet()	Initializes and creates application wallet. The wallet contains DID, 12 Mnemonic Phrases, Public Key, and Private Key
isBiometricAssetsEnabled	boolean	isBiometricAssetsEnabled()	Check and indicates if the biometric assets (Pin, Face ID / Touch ID, Live ID) are registered
isDeviceAuthEnrolled	boolean	isDeviceAuthEnrolled()	Checks and indicates if user has setup biometric option for login purpose
isDeviceFingerPrintEnable	BIDGenericResponse	isDeviceFingerPrintEnable()	Checks and indicates if user has enabled fingerprint on the device
isDeviceSecure	BIDGenericResponse	isDeviceSecure(Context context)	Checks and indicates if keyguard security is enabled in phone device
isDigitalAssetsEnabled	boolean	isDigitalAssetsEnabled()	Checks and indicates if digital assets (Driver's License, SSN, Passport, etc.) are registered
isLiveIDRegistered	boolean	isLiveIDRegistered()	Checks and indicates if user has registered Live ID
isOriginAlreadyExisting	BIDGenericResponse	isOriginAlreadyExisting(String userId, BIDOrigin origin)	Checks and indicates if existing origin is being used
isPersonalAssetsEnabled	boolean	isPersonalAssetsEnabled()	Check and indicates if any of the personal assets (email, phone) are enabled.
isPinRegistered	boolean	isPinRegistered()	Checks and indicates if user has setup (registered) login Pin
isReady	boolean	isReady()	Checks and indicates if the SDK is ready for use. BlockIDSDK must be ready before using any functions of SDK
isRestoreModeOn	boolean	isRestoreModeOn()	Checks and indicates id the restore mode is set to true
isTrustedSessionSource	boolean	isTrustedSessionSource(String sessionUrl)	Checks and indicates if the given session URL is trusted by BlockID SDK
[redeemAccessCode]	void	redeemAccessCode(String code, String lat, String lon, String pushID, String versionName, AddScepAccountCallback addScepAccountCallback)	Redeem access code
registerDocument	void	registerDocument(Context context, LinkedHashMap dataObject, Bitmap liveIdBitmap, String liveIdProofedBy, String docSignToken, String liveIdSignToken, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)	Store (add) the given document data along with Live ID
registerDocument	void	registerDocument(Context context, LinkedHashMap dataObject, Bitmap liveIdBitmap, String liveIdProofedBy, String docSignToken, String liveIdSignToken, boolean storeArtifacts, boolean syncArtifacts, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)	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
registerDocument	void	registerDocument(Context context, LinkedHashMap dataObject, String signToken, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)	Store (add) the given document data
registerDocument	void	registerDocument(Context context, LinkedHashMap dataObject, String signToken, boolean storeArtifacts, boolean syncArtifacts, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)	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
registerFIDO2Key	void	registerFIDO2Key(@NonNull Activity activity, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @NonNull RegisterFIDO2KeyCallback callback)	Provides the capability to register web-based FIDO2 security key
registerFIDO2Key	void	registerFIDO2Key(@NonNull Activity activity, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @Nullable String fileName, @NonNull FIDO2Callback callback)	Provides the capability to register Web based FIDO2 security key with custom HTML
registerFIDO2Key	void	registerFIDO2Key*(@NonNull Context context, @NonNull* BIDLinkedAccount account, @NonNull FIDO2KeyType type, FIDO2Observer observer, @NonNull FIDO2Callback callback)	Provides the capability to register FIDO2 security key with BIDLikedAccount
registerFIDO2Key	void	registerFIDO2Key(Context context, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @NonNull FIDO2KeyType type, FIDO2Observer observer, @NonNull FIDO2Callback callback)	Provides the capability to register Native FIDO2 security key.
registerTenant	void	registerTenant(BIDTenant bidTenant, BIDTenantRegistryCallback callback)	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
resetPassword	void	resetPassword(String userID, String password, String newPassword, BIDAccount account, BIDOrigin bidOrigin, ResetPasswordCallback resetPasswordCallback)	Resets user's password
resetRestorationData	void	resetRestorationData()	Resets all restoration data
resetSDK	void	resetSDK(String licenseKey)	Purges the SDK wallet and all data stored/owned by the SDK
restoreUserDataFromWallet	void	restoreUserDataFromWallet(IAccountRestoreListener accountRestoreListener)	Performs user data restoration from application's wallet
restoreWallet	void	restoreWallet(List<String> mnemonicPhrase)	Returns if the application's wallet is restored
setDvcId	void	setDvcId(@NonNull String dvcId)	Sets application's dvcID (Document Verification Connector Identifier)
setLicenseKey	void	setLicenseKey(@NonNull String key)	Sets application's license key
setLiveID	void	setLiveID(Bitmap liveIdBitmap, String proofedBy, String signToken, ILiveIDEnrollListener liveIDResponseListener)	Register (store) user's Live ID data
setProxy	void	setProxy(@NonNull String host, int port, @Nullable String userName, @Nullable String password)	Add proxy to all the outbound API calls used within the SDK
setRestoreMode	void	setRestoreMode()	Sets user's account restore mode to true
setSelectedAccount	void	setSelectedAccount(BIDLinkedAccount account)	Sets an user's linked account as currently selected account
unenrollPin	void	unenrollPin(BIDDocumentProvider.IDocumentUnEnrollmentListener unEnrollmentListener)	Remove (delete) the existing Pin
unlinkAccount	void	unlinkAccount(BIDLinkedAccount linkedAccount, String pushId, UnlinkAccountCallback callback)	Unlink the existing user account
unRegisterDocument	void	unRegisterDocument(Context context, LinkedHashMap dataObject, BIDDocumentProvider.IDocumentUnEnrollmentListener unEnrollListener)	Remove (delete) the existing document
updateAccountInfo	void	updateAccountInfo(@NonNull BIDLinkedAccount account, @NonNull HashMap<String, Object> deviceInfo, @NonNull String pushId, UpdateAccountInfoCallback callback)	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
validateAccessCode	void	validateAccessCode(String code, IADValidationCallback iadValidationCallback)	Check validity of access code. Access code validation is required during access code redemption process
verifyDocument	void	verifyDocument(@NonNull LinkedHashMap<String, Object> document, @NonNull String[] verifications, @NonNull IVerifyDocumentListener listener)	Verify document data that user has presented through BlockID partners
verifyDocument	void	verifyDocument(@NonNull String dvcID, @NonNull LinkedHashMap document, @NonNull String[] verifications, @NonNull IVerifyDocumentListener listener)	Verify document data that user has presented through BlockID partners
verifyLiveID	void	verifyLiveID(Context context, Bitmap bitmap, BIDAuthProvider.IFaceComparisonListener listener)	Verify Live ID
verifyPin	void	verifyPin(String pin)	Returns if the given is verified
verifyUserAccount	void	verifyUserAccount(String code, String userID, String password, String phoneNumber, String api, String tag, String community, String versionName, String lat, String lon, String device_id, String pushID, AddScepAccountCallback addScepAccountCallback)	Verify user account

Method Detail

---

addNativeAccount

public void addNativeAccount(String pushId, String userID, String password, BIDOrigin bidOrigin, String versionName, String lat, String lon, AddScepAccountCallback addScepAccountCallback)

• Add user account based on given userid and password

Parameters
pushId	String: Push token of user's device. Use for sending push notifications
userID	String: UserID of user's account.
password	String: Password of user's account.
bidOrigin	BIDOrigin: Origin details.
versionName	String: Application version number (name).
lat	String: Latitude of user's location.
lon	String: Longitude of user's location.
addScepAccountCallback	AddScepAccountCallback: The block to execute after the response is received

---

addPreLinkedUser

public void addPreLinkedUser(String userId, String scep_hash, String scep_privatekey, BIDOrigin origin, BIDAccount account, LinkUserCallback callback)

• Provides an option to add already linked user

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

---

authenticateFIDO2Key

public void authenticateFIDO2Key(@NonNull Activity activity, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @NonNull FIDO2Callback callback)

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

Parameter
activity	Activity: The application’s activity on top of which the registration screen will be shown.
userName	String: The user name which requires to be authenticated.
tenantDNS	String: The tenant's DNS against which the user is authenticated.
communityName	String: The community name against which the user is authenticated.
callback	FIDO2Callback: The block to execute after the response is received.

---

authenticateFIDO2Key

public void authenticateFIDO2Key(@NonNull Activity activity, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @Nullable String fileName, @NonNull FIDO2Callback callback)

• Provides the capability to authenticate a web-based FIDO2 security key with custom HTML.

Parameter
activity	Activity: The application activity from the registration screen
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: HTML file name.
callback	FIDO2Callback: The block to execute after the response is received.

---

authenticateFIDO2Key

public void authenticateFIDO2Key(@NonNull Context context, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @NonNull FIDO2KeyType type, FIDO2Observer observer, @NonNull FIDO2Callback callback)

• Provides the capability to authenticate a native FIDO2 security key.

Parameter
context	Context: Current activity context.
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.
type	FIDO2KeyType: FIDO2KeyType
observer	FIDO2Observer: FIDO2Observer object
callback	FIDO2Callback: The block to execute after receiving the response.

---

authenticateFIDO2Key

public void authenticateFIDO2Key(@NonNull Context context, @NonNull FIDO2KeyType type, FIDO2Observer observer, @Nullable String userId, @NonNull String sessionID, @NonNull String sessionUrl, String scopes, LinkedHashMap<String, Object> metadata, String creds, @NonNull BIDOrigin origin, String latitude, String longitude, String versionName, @NonNull FIDO2Callback callback)

• Provides the capability to authenticate a native FIDO2 security key with a linked account.

Parameter
context	Context: Current activity context.
type	FIDO2KeyType: FIDO2KeyType
observer	FIDO2Observer: FIDO2Observer object
userId	String: UserID of user's account.
sessionID	FIDO2KeyType: FIDO2KeyType
sessionUrl	FIDO2Observer: FIDO2Observer object
scopes	String: Scopes defined for authentication
metadata	LinkedHashMap<String, Object>: Authentication data.
creds	String: Credential of user's account.
origin	BIDOrigin: Origin details of the user.
latitude	String: Latitude of user's location.
longitude	String: Longitude of user's location.
versionName	String: Application Version number
callback	FIDO2Callback: The block to execute after receiving the response.

---

authenticateUser

public void authenticateUser(@Nullable String userId, String sessionId, LinkedHashMap<String, Object> dataObject, String creds, BIDOrigin bidOrigin, String latitude, String longitude, String versionName, AuthenticateUserCallback authenticateUserCallback)

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

Parameter
userId	String: UserID of user's account.
sessionId	String: Session for authentication.
dataObject	LinkedHashMap<String, Object>: Authentication data.
creds	String: Credential of user's account.
bidOrigin	BIDOrigin: Origin details of a user.
latitude	String: Latitude of a user location.
longitude	String: Longitude of a user location.
versionName	String: Application version number
authenticateUserCallback	AuthenticateUserCallback: The block to execute after the response is received.

---

authenticateUser

public void authenticateUser(@Nullable String userId, String sessionId, String sessionUrl, LinkedHashMap<String, Object> dataObject, String creds, BIDOrigin bidOrigin, String latitude, String longitude, String versionName, AuthenticateUserCallback authenticateUserCallback)

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

Parameter
userId	String: UserID of user's account.
sessionId	String: Session for authentication.
sessionUrl	String: Complete session URL containing sessionId.
dataObject	LinkedHashMap<String, Object>: Authentication data.
creds	String: Credential of user's account.
bidOrigin	BIDOrigin: Origin details of a user.
latitude	String: Latitude of a user location.
longitude	String: Longitude of a user location.
versionName	String: Application version number
authenticateUserCallback	AuthenticateUserCallback: The block to execute after the response is received.

---

authenticateUser

public void authenticateUser(@NonNull Context context, @Nullable String userId, String sessionId, String scopes, String creds, BIDOrigin bidOrigin, String latitude, String longitude, String versionName, HashMap<String, Object> extraData, AuthenticateUserCallback authenticateUserCallback)

• Authenticate user with scope (UWL1.0).

Parameter
context	Context: Current activity context.
userId	String: UserID of user's account.
sessionId	String: Session for authentication.
scopes	String: Scopes defined for authentication
creds	String: Credential of user's account.
bidOrigin	BIDOrigin: Origin details of user.
latitude	String: Latitude of user's location.
longitude	String: Longitude of user's location.
versionName	String: Application version number
extraData	HashMap<String, Object>: Extra Data which will append with scope data
authenticateUserCallback	AuthenticateUserCallback: The block to execute after the response is received.

---

authenticateUser

public void authenticateUser(@NonNull Context context, @Nullable String userId, String sessionId, String sessionUrl, String scopes, LinkedHashMap<String, Object> metadata, String creds, BIDOrigin bidOrigin, String latitude, String longitude, String versionName, HashMap<String, Object> extraData, AuthenticateUserCallback authenticateUserCallback)

• Authenticate user with scope (UWL2.0).

Parameter
context	Context: Current activity context.
userId	String: UserID of user's account.
sessionId	String: Session for authentication.
sessionUrl	String: Complete session URL containing sessionId.
scopes	String: Scopes defined for authentication
LinkedHashMap<String, Object>	metadata: Metadata for FIDO webauthn payload
creds	String: Credential of user's account.
bidOrigin	BIDOrigin: Origin details of user.
latitude	String: Latitude of user's location.
longitude	String: Longitude of user's location.
versionName	String: Application version number
extraData	HashMap<String, Object>: Extra Data which will append with scope data
authenticateUserCallback	AuthenticateUserCallback: The block to execute after the response is received.

---

checkDeviceFingerPrintEnabled

public BIDGenericResponse checkDeviceFingerPrintEnabled()

• Checks if fingerprint is enabled on device

---

checkIfADRequired

public void checkIfADRequired(String code, String tag, String api, String community, IADValidationCallback adValidationCallback)

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

Parameter
code	String: Access code to be validated
tag	String: Tenant tag
api	String: Tenant's URL
community	String: Tenant's community
adValidationCallback	IADValidationCallback: The block to execute after the response is received

---

checkIfDeviceIsSecured

public BIDGenericResponse checkIfDeviceIsSecured()

• Checks and indicates if keyguard security is enabled in phone device.

---

checkSCEPCertificate

public void checkSCEPCertificate(BIDLinkedAccount requestedAccount, SCEPCertificateCallback callback)

• Check linked account secp certificat expired and If certificate is expired renew it.

Parameter
requestedAccount	BIDLinkedAccount: Linked user's account
callback	SCEPCertificateCallback: The block to execute after the response is received

---

commitApplicationWallet

public void commitApplicationWallet()

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

---

commitRestorationData

public void commitRestorationData()

• Commits the application's restoration data

---

createAccessCode

public void createAccessCode(CreateAccessCodePayloademailPayload, AccessCodeCallback accessCodeCallback)

• Create access for email verification

Parameter
emailPayload	CreateAccessCodePayload: access code payload
accessCodeCallback	SCEPCertificateCallback: The block to execute after the response is received.

---

decryptString

public String decryptString(String inputData, String senderKey)

• Performs decryption of data with the given public key.

Parameter
inputData	String: Data to decrypt
senderKey	String: Public key used to decrypt the data

---

encryptString

public String encryptString(String inputData, String rcptKey)

• Performs encryption of data with the given public key.

Parameter
inputData	String: Data to encrypt
senderKey	String: Public key used to encrypt the data

---

enrollPin

public void enrollPin(String pin, String proofedBy, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)

• Register Pin for login purposes.

Parameter
pin	String: Pin to enroll (register)
proofedBy	String: This identifies the entity responsible for proofing. The default value is “blockid”
enrollListener	BIDDocumentProvider.IDocumentEnrollmentListener: The block to execute after the response is received.

---

fetchDocuments

public void fetchDocuments(HashMap<String, Object> requestMap, FetchDocumentsCallback callback)

• Fetches & returns user documents from server

Method Parameter
requestMap	HashMap<String, Object>: Document hashmap to be fetched
callback	FetchDocumentsCallback: The block to execute after the response is received.

RequestMap 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	boolean 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 void fetchGlobalConfig(@NonNull BIDTenant tenant, GlobalConfigCallback callback)

• Fetches & returns Global Config

Parameter
tenant	BIDTenant: Tenant details.
callback	GlobalConfigCallback: The block to execute after the response is received.

---

generateNewSession

public void generateNewSession(BIDOrigin origin, String authType, String scopes, GenerateNewSessionListener generateNewSessionListener)

• Generate new session.

Parameter
origin	BIDOrigin: Origin details
authType	String: Authentication type
scopes	String: Scopes (comma separated) value.
generateNewSessionListener	GenerateNewSessionListener: The block to execute after the response is received

---

getBiometricAssetEnrollments

public Enrollments.BiometricAssets getBiometricAssetEnrollments()

• Returns an instance of BiometricAssets class.

---

getDID

public String getDID()

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

---

getDigitalAssetEnrollments

public Enrollments.DigitalAssets getDigitalAssetEnrollments()

• Returns an instance of DigialAssets class

---

getIAL

public void getIAL(IALCallback callback)

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

Parameter
callback	IALCallback : The block to execute after the response is received.

---

getInstance

public static BlockIDSDK getInstance()

• Returns an instance of BlockIDSDK.

---

getKYC

public void getKYC(KYCCallback callback)

• Get KYC Hash

Parameter
callback	KYCCallback: The block to execute after the response is received.

---

getLicenseModule

public BIDGenericResponse getLicenseModule()

• Returns license modules setup for given tenant.

---

getLinkedUserList

public BIDGenericResponse getLinkedUserList()

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

---

getLiveIdImage

public BIDGenericResponse getLiveIdImage()

• Returns registered Live ID image of user.

---

getMessageGateways

public void getMessageGateways(@NonNull BIDTenant tenant, MessageGatewaysCallback callback)

• Returns a list of the message gateways available for the given tenant.

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

---

getMnemonic

public List<String> getMnemonic()

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

---

getOfflineAuthPayload

public BIDGenericResponse getOfflineAuthPayload(BIDLinkedAccount bidLinkedAccount)

• Returns offline authentication payload.

Parameters
bidLinkedAccount	BIDLinkedAccount: Linked user's account

---

getPersonalAssetEnrollments

public Enrollments.PersonalAssets getPersonalAssetEnrollments()

• Return an instance of PersonalAssets class

---

getPasswordPolicy

public void getPasswordPolicy(@NonNull BIDLinkedAccount account, @NonNull PasswordPolicyCallback callback)

• Return password policy for provided BIDLinkedAccount

Parameters
account	BIDLinkedAccount: Requested account
callback	PasswordPolicyCallback: The block to execute after the response is received.

---

getProxyDetails

public ProxyDetails getProxyDetails()

• Returns proxy details.

---

getPublicKey

public String getPublicKey()

• Returns application wallet's public key.

---

getScopes

public void getScopes(String userId, String scopes, String creds, BIDOrigin bidorigin, String lat, String longitude, GetScopeCallback callback)

• Returns user's data based on defined scopes (e.g. firstName, ial, dl_object).

Parameters
userId	String: UserID of user account
scopes	String: Comma separated scopes
creds	String: User's credentials
bidorigin	BIDOrigin: Origin details of user
lat	String: Latitude of user's location.
longitude	String: Longitude of user's location.
callback	GetScopeCallback: Callback to return scope data.

---

getSelectedAccount

public BIDGenericResponse getSelectedAccount()

• Returns the selected user account.

---

getServerPublicKey

public String getServerPublicKey()

• Returns server public key of registered tenant.

---

getSessionResponse

public void getSessionResponse(String sessionURL, String sessionId, GetNewSessionListener getNewSessionListener)

• Get session response for given session URL and sessionID.

Parameters
sessionURL	String: Session URL for which response is required.
sessionId	String: SessionID for which response is required.
getNewSessionListener	GetNewSessionListener: The block to execute after the response is received

---

getTenant

public BIDTenant getTenant()

• Returns registered tenant object.

---

getTOTP

public BIDGenericResponse getTOTP()

• Returns time based OTP value

---

getTOTP

public BIDGenericResponse getTOTP(String otpSeed)

• Returns time based OTP value based on given OTP seed.

Parameters
otpSeed	String: OTP seed to generate TOTP

---

getVC

public void getVC(@NonNull String downloadURL, @NonNull VCCallback callback)

• Returns VC data from download URL

Parameters
downloadURL	String: Issued VC download URL
callback	VCCallback: The block to execute after the response is received.

---

getVersion

public String getVersion()

• Returns BlockID SDK version.

---

initialize

public static void initialize(Context context)

• Initializes and creates an instance of BlockIDSDK.

Parameters
context	Context: Application context

---

getVP

public void getVP(JSONObject vcData, VPCallback callback)

• Returns VP object based on VC data

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

---

initiateWallet

public void initiateWallet()

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

---

isBiometricAssetsEnabled

public boolean isBiometricAssetsEnabled()

• Check and indicates if the biometric assets (Pin, Face ID / Touch ID, Live ID) are registered.

---

isDeviceAuthEnrolled

public boolean isDeviceAuthEnrolled()

• Checks and indicates if user has setup biometric option for login purpose.

---

isDeviceFingerPrintEnable

public BIDGenericResponseisDeviceFingerPrintEnable()

• Checks and indicates if user has enabled fingerprint on the device.

---

isDeviceSecure

public BIDGenericResponseisDeviceSecure(Context context)

• Checks and indicates if keyguard security is enabled in phone device.

Parameter
context	Context: Activity context

---

isDigitalAssetsEnabled

public boolean isDigitalAssetsEnabled()

• Checks and indicates if digital assets (Driver's License, SSN, Passport, etc.) are registered

---

isLiveIDRegistered

public boolean isLiveIDRegistered()

• Checks and indicates if user has registered Live ID.

---

isOriginAlreadyExisting

public BIDGenericResponse isOriginAlreadyExisting(String userId, BIDOrigin origin)

• Checks and indicates if existing origin is being used.

Parameter
userId	String: UserID of user account
origin	BIDOrigin: Origin details of user

---

isPersonalAssetsEnabled

public boolean isPersonalAssetsEnabled()

• Check and indicates if any of the personal assets (email, phone) are enabled.

---

isPinRegistered

public boolean isPinRegistered()

• Checks and indicates if user has setup (registered) login Pin.

---

isReady

public boolean isReady()

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

---

isRestoreModeOn

public boolean isRestoreModeOn()

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

---

isTrustedSessionSource

public boolean isTrustedSessionSource(String sessionUrl)

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

Parameter
sessionUrl	String: Session URL to be verified from list of trusted source

---

registerDocument

public void registerDocument(Context context, LinkedHashMap<String, Object> dataObject, Bitmap liveIdBitmap, String liveIdProofedBy, String docSignToken, String liveIdSignToken, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)

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

Parameter
context	Context: Current activity context.
dataObject	LinkedHashMap<String, Object>: Document data to be stored
liveIdBitmap	Bitmap: Live ID image bitmap to be stored.
liveIdProofedBy	String: The entity responsible for proofing the Live ID (selfie). For BlockID Live ID (selfie) scanner, the default value is “blockid”
docSignToken	String: Signature token of document to verify if the document data is modified or not
liveIdSignToken	String: Signature token of Live ID to verify if the Live ID is modified or not
enrollListener	BIDDocumentProvider.IDocumentEnrollmentListener: The block to execute after the response is received

---

registerDocument

public void registerDocument(Context context, LinkedHashMap<String, Object> dataObject, Bitmap liveIdBitmap, String liveIdProofedBy, String docSignToken, String liveIdSignToken, boolean storeArtifacts, boolean syncArtifacts, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)

• 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.

Parameter
context	Context: Current activity context.
dataObject	LinkedHashMap<String, Object>: Document data to be stored
liveIdBitmap	Bitmap: Live ID image bitmap to be stored.
liveIdProofedBy	String: The entity responsible for proofing the Live ID (selfie). For BlockID Live ID (selfie) scanner, the default value is “blockid”
docSignToken	String: Signature token of document to verify if the document data is modified or not
liveIdSignToken	String: Signature token of Live ID to verify if the Live ID is modified or not
storeArtifacts	boolean: Flag to indicate if the document must be stored on BlockID platform
syncArtifacts	boolean: Flag to indicate if the document must be synced on BlockID platform
enrollListener	BIDDocumentProvider.IDocumentEnrollmentListener: The block to execute after the response is received

---

registerDocument

public void registerDocument(Context context, LinkedHashMap<String, Object> dataObject, String signToken, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)

• Store (add) the given document data.

Parameter
context	Context: Current activity context.
dataObject	LinkedHashMap<String, Object>: Document data to be stored
signToken	String: Signature token of document to verify if the document data is modified or not
enrollListener	BIDDocumentProvider.IDocumentEnrollmentListener: The block to execute after the response is received

---

registerDocument

public void registerDocument(Context context, LinkedHashMap<String, Object> dataObject, String signToken, boolean storeArtifacts, boolean syncArtifacts, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)

• 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.

Parameter
context	Context: Current activity context.
dataObject	LinkedHashMap<String, Object>: Document data to be stored
signToken	String: Signature token of document to verify if the document data is modified or not
storeArtifacts	boolean: Flag to indicate if the document must be stored on BlockID platform
syncArtifacts	boolean: Flag to indicate if the document must be synced on BlockID platform
enrollListener	BIDDocumentProvider.IDocumentEnrollmentListener: The block to execute after the response is received

---

registerFIDO2Key

public void registerFIDO2Key(@NonNull Activity activity, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @NonNull FIDO2Callback callback)

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

Parameter
activity	Activity: The application activity from the registration screen
userName	String: The user name which requires registration.
tenantDNS	String: The tenant DNS against which the user is registered.
communityName	String: The community name against which the user is registered.
callback	FIDO2Callback: The block to execute after the response is received.

---

registerFIDO2Key

public void registerFIDO2Key(@NonNull Activity activity, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @NullableString fileName, @NonNull FIDO2Callback callback)

• Provides the capability to register a web-based FIDO2 security key using custom HTML.

Parameter
activity	Activity: The application activity from the registration screen
userName	String: The user name which requires registration.
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: HTML file name
callback	FIDO2Callback: The block to execute after receiving the response.

---

registerFIDO2Key

public void registerFIDO2Key(@NonNull Context context, @NonNull BIDLinkedAccount account,@NonNull FIDO2KeyType type, FIDO2Observer observer,@NonNull FIDO2Callback callback

• Provides the capability to register a native FIDO2 security key using BIDLinkedAccount.

Parameter
context	Context: Current activity context.
account	BIDLinkedAccount: The linked account which requires to be registered.
type	FIDO2KeyType: Fido Key Type
observer	FIDO2Observer: Fido2 Observer
callback	FIDO2Callback: The block to execute after the response is received.

---

registerFIDO2Key

public void registerFIDO2Key(@NonNull Activity activity, @NonNull String userName, @NonNull String tenantDNS, @NonNull String communityName, @NullableString fileName, @NonNull FIDO2Callback callback)

• Provides the capability to register a native FIDO2 security key.

Parameter
context	Context: Current activity context.
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: HTML file name
type	FIDO2KeyType: Fido Key Type
observer	FIDO2Observer: Fido2 Observer
callback	FIDO2Callback: The block to execute after the response is received.

---

registerTenant

public void registerTenant(BIDTenant bidTenant, BIDTenantRegistryCallback callback)

• 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.

Parameter
tenant	BIDTenant: Tenant details
callback	BIDTenantRegistryCallback: The block to execute after the response is received

---

resetPassword

public void resetPassword(String userID, String password, String newPassword, BIDAccount account, BIDOrigin bidOrigin, ResetPasswordCallback resetPasswordCallback)

• Resets user's password.

Parameter
userID	String: Userid of user's account.
password	String: Current password of user's account.
newPassword	String: New password for user's account.
account	BIDAccount: User's account for which password reset is required
bidOrigin	BIDOrigin: Origin details of user's account
resetPasswordCallback	ResetPasswordCallback: The block to execute after the response is received

---

resetRestorationData

public void resetRestorationData()

• Resets all restoration data.

---

resetSDK

public void resetSDK(String licenseKey)

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

Parameter
licenseKey	String: Application's license key

---

restoreUserDataFromWallet

public void restoreUserDataFromWallet(IAccountRestoreListener accountRestoreListener)

• Performs user data restoration from application's wallet.

Parameter
accountRestoreListener	IAccountRestoreListener: The block to execute after the response is received

---

restoreWallet

public boolean restoreWallet(List<String> mnemonicPhrase)

• Returns if the application's wallet is restored.

Parameter
mnemonicPhrase	List<String>: List of 12 mnemonic phrases

---

setDvcId

public void setDvcId(@NonNull String dvcId)

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

Parameter
dvcId	String: Application's dvcID (Document Verification Connector Identifier)

---

setLicenseKey

public void setLicenseKey(@NonNull String key)

• Sets application's license key.

Parameter
key	String: Application's license key

---

setLiveID

public void setLiveID(Bitmap liveIdBitmap, String proofedBy, String signToken, ILiveIDEnrollListener liveIDResponseListener)

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

Parameter
liveIdBitmap	Bitmap: Live ID (Selfie) image
proofedBy	String: The entity responsible for proofing the Live ID (selfie). For BlockID Live ID (selfie) scanner, the default value is “blockid”
signToken	String: Signature token to verify if the Live ID (selfie) data is modified or not
liveIDResponseListener	ILiveIDEnrollListener: The block to execute after the response is received

---

setProxy

public void setProxy(@NonNull String host, int port, @Nullable String userName, @Nullable String password)

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

Parameter
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.

---

setRestoreMode

public void setRestoreMode()

• Sets user's account restore mode to true.

---

setSelectedAccount

public void setSelectedAccount(BIDLinkedAccount account)

• Sets an user's linked account as currently selected account.

Parameter
account	BIDLinkedAccount: User's linked account

---

unenrollPin

public void unenrollPin(BIDDocumentProvider.IDocumentUnEnrollmentListener unEnrollmentListener)

• Remove (delete) the existing Pin.

Parameter
unEnrollmentListener	BIDDocumentProvider.IDocumentUnEnrollmentListener: The block to execute after the response is received

---

unlinkAccount

public void unlinkAccount(BIDLinkedAccount linkedAccount, String pushId, UnlinkAccountCallback callback)

• Unlink the existing user account.

Parameter
linkedAccount	BIDLinkedAccount: Currently linked user account.
pushId	String: PushID (push token) of device.
callback	UnlinkAccountCallback: The block to execute after the response is received

---

unRegisterDocument

public void unRegisterDocument(Context context, LinkedHashMap<String, Object> dataObject, BIDDocumentProvider.IDocumentUnEnrollmentListener unEnrollListener)

• Remove (delete) the existing document.

Parameter
context	Context: Current activity context.
dataObject	LinkedHashMap<String, Object>: Document to be removed.
unEnrollListener	BIDDocumentProvider.IDocumentUnEnrollmentListener: The block to execute after the response is received

---

updateAccountInfo

public void updateAccountInfo(@NonNull BIDLinkedAccount account, @NonNull HashMap<String,Object> deviceInfo, @NonNull String pushId, UpdateAccountInfoCallback callback) Linked

• 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.

Parameter
account	BIDLinkedAccount : Account
deviceInfo	LinkedHashMap<String, Object>: 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
pushId	String: Device's push Id
callback	UpdateAccountInfoCallback: The block to execute after the response is received.

---

validateAccessCode

public void validateAccessCode(String code, IADValidationCallback iadValidationCallback)

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

Parameter
code	String: access code
iadValidationCallback	IADValidationCallback: The block to execute after the response is received

---

verifyDocument

public void verifyDocument(@NonNull LinkedHashMap<String, Object> document, @NonNull String[] verifications, @NonNull IVerifyDocumentListener listener)

• Verify document data that user has presented through BlockID partners.

Parameter
document	LinkedHashMap<String, Object>: Hash Map of document data
verifications	String[]: List of verification
listener	IVerifyDocumentListener: The block to execute after the response is received

---

verifyDocument

public void verifyDocument(@NonNull String dvcID, @NonNull LinkedHashMap<String, Object> document, @NonNull String[] verifications, @NonNull IVerifyDocumentListener listener)

• Verify document data that user has presented through BlockID partners.

Parameter
dvcID	String: Document Verification Connector Identifier.
document	LinkedHashMap<String, Object>: Hash Map of document data
verifications	String[]: List of verification
listener	IVerifyDocumentListener: The block to execute after the response is received

---

verifyLiveID

public void verifyLiveID(Context context, Bitmap bitmap, BIDAuthProvider.IFaceComparisonListener listener)

• Verify Live ID.

Parameter
context	Context: Context of activity
bitmap	Bitmap: Bitmap to compare with enrolled Live ID (selfie)
listener	BIDAuthProvider.IFaceComparisonListener: The block to execute after the response is received

---

verifyPin

public boolean verifyPin(String pin)

• Returns if the given is verified.

Parameter
pin	String: Current Pin for verification

---

verifyUserAccount

public void verifyUserAccount(String code, String userID, String password, String phoneNumber, String api, String tag, String community, String versionName, String lat, String lon, String device_id, String pushID, AddScepAccountCallback addScepAccountCallback)

• Verify user account.

Parameter
code	String: Access code
userID	String: UserID of user's account.
password	String: Password of user's account.
phoneNumber	String: User's phone number
api	String: Tenant's URL
tag	String: Tenant's tag
community	String: Tenant's community name.
versionName	String: Application version number.
lat	String: Latitude of user's location.
lon	String: Longitude of user's location.
device_id	String: User's deviceID
pushID	String: User's device pushID (push token).
addScepAccountCallback	AddScepAccountCallback: The block to execute after the response is received

Interface Summary

Name	Description
AccessCodeCallback	Callback for event when access code created.
AddScepAccountCallback	Callback for event when SCEP account is being added.
AuthenticateUserCallback	Callback for event when user has been authentication.
BIDTenantRegistryCallback	Callback for event when application tenant is registered.
FetchDocumentsCallback	Callback for event when user's document is fetched.
FIDO2Callback	Callback for event when FIDO2 key registered or authenticated.
GetScopeCallback	Callback for event when scopes are received.
GenerateNewSessionListener	Callback for event when new session is created (generated).
GetNewSessionListener	Callback for event when new session is received.
GlobalConfigCallback	Callback for event when global config are received.
IAccountRestoreListener	Callback for event when user account is restored.
IADValidationCallback	Callback for event when user's account validation is required.
IALCallback	Callback for event when user IAL is received.
ILiveIDEnrollListener	Callback for event when Live ID is enrolled (registered).
IVerifyDocumentListener	Callback for event when document verification service is used.
KYCCallback	Callback for event when KYC has is received.
LinkUserCallback	Callback for event when user account is linked.
MessageGatewaysCallback	Callback for get message gateways.
ResetPasswordCallback	Callback for event when password is reset.
SCEPCertificateCallback	Callback for SCEP Check.
UnlinkAccountCallback	Callback for event when user account is unlinked.
UpdateAccountInfoCallback	Callback for event when account information is updated.
VCCallback	Callback for event when VC data is received.
VPCallback	Callback for event when VP data is received.

---

AccessCodeCallback

public interface BlockIDSDK.AccessCodeCallback

• Callback for event when access code created.

Method Summary

void onAccessCodeResponse(boolean status, CreateAccessCodeResponse createAccessCodeResponse, ErrorManager.ErrorResponse error)

Parameters
status	boolean: Indicates if the access code is created or not.
createAccessCodeResponse	CreateAccessCodeResponse: Access code response
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

---

AddScepAccountCallback

public static interface BlockIDSDK.AddScepAccountCallback

• Callback for event when SCEP account is being added.

Method Summary

void onScepAccountAdded(boolean status, ErrorManager.ErrorResponse error)

• Called when SCEP account is added.

Parameters
status	boolean: Indicates if the SCEP account is added or not.
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned

---

AuthenticateFIDO2KeyCallback

public static interface BlockIDSDK.AuthenticateFIDO2KeyCallback

• Callback for event when FIDO2 key is authenticated.

Method Summary

void onAuthenticateFIDO2Key(boolean status, ErrorResponse errorResponse)

• Called when FIDO2 key is authenticated.

Parameters
status	boolean: Indicates if the FIDO2 key is authenticated or not
error	ErrorResponse: In case of error, an object of ErrorResponse is returned

---

AuthenticateUserCallback

public static interface BlockIDSDK.AuthenticateUserCallback

• Callback for event when user has been authentication.

Method Summary

void onUserAuthenticated(boolean status, String sessionId, ErrorManager.ErrorResponse error)

• Called when user has been authenticated.

Parameters
status	boolean: Indicates if the user is authenticated or not.
sessionId	String: Returns session id for user authentication.
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned

---

BIDTenantRegistryCallback

public static interface BlockIDSDK.BIDTenantRegistryCallback

• Callback for event when application tenant is registered.

Method Summary

void onTenantRegistration(boolean status, ErrorManager.ErrorResponse error, BIDTenant tenant)

• Called when application tenant is registered.

Parameters
status	boolean: Indicates if the user is linked or not.
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned
tenant	BIDTenant: An object of BIDTenant being registered

---

FIDO2Callback

public static interface BlockIDSDK.FIDO2Callback

• Callback for event when FIDO2 key is registered or authenticated.

Method Summary

void onFIDO2Response(boolean status, ErrorResponse errorResponse)

• Called when FIDO2 key is authenticated.

Parameters
status	boolean: Indicates if the FIDO2 key is registered or authenticated.
error	ErrorResponse: In case of error, an object of ErrorResponse is returned.

---

FetchDocumentsCallback

public static interface BlockIDSDK.FetchDocumentsCallback

• Callback for event when user's document is fetched.

Method Summary

void onFetchDocumentsCallback(boolean status, LinkedHashMap<String, Object> result, ErrorManager.ErrorResponse error,)

• Callback for event when user's document is fetched.

Parameters
status	boolean: Indicates if the user''s document is fetched or not.
result	LinkedHashMap<String, Object>: A Hash-map of user document is returned
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

---

GenerateNewSessionListener

public static interface BlockIDSDK.GenerateNewSessionListener

• Callback for event when new session is created (generated).

Method Summary

void onNewSessionGenerated(boolean status, String sessionURL, SessionApi.GenerateNewSessionResponsePayload result, ErrorManager.ErrorResponse errorResponse)

• Called when new session is created (generated).

Parameters
status	boolean: Indicates if the new session is created (generated) or not
sessionURL	String: Result of new session being received.
result	SessionApi.GenerateNewSessionResponsePayload: A response payload after new session is created (generated)
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned

---

GetScopeCallback

public static interface BlockIDSDK.GetScopeCallback

• Callback for event when scopes are received.

Method Summary

void onGetScopeResponse(LinkedHashMap<String, Object> response, ErrorResponse error)

• Called when all scopes are received.

Parameters
response	LinkedHashMap<String, Object> : scopes map.
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

---

GlobalConfigCallback

public static interface BlockIDSDK.GlobalConfigCallback

• Callback for event when scopes are received.

Method Summary

void onGlobalConfigCallback(booleanstatus, String result, ErrorResponse error);

• Callback for event when scopes are received.

Parameters
status	boolean : Indicates if the global config is received or not.
result	String: Global Config details are returned.
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

---

GetNewSessionListener

public static interface BlockIDSDK.GetNewSessionListener

• Callback for event when new session is received.

Method Summary

void onNewSessionReceived(boolean status, String result, ErrorManager.ErrorResponse errorResponse)

• Called when new session is received.

Parameters
status	boolean: Indicates if the new session is received or not
result	String: Result of new session being received.
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned

---

IAccountRestoreListener

public static interface BlockIDSDK.IAccountRestoreListener

• Callback for event when user account is restored.

Method Summary

void onAccountRestoreListener(boolean status, ErrorManager.ErrorResponse error, String message)

• Called when user account is restored.

Parameters
status	boolean: Indicates if user account is restored or not.
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned
message	String: Error / Success message

---

IADValidationCallback

public static interface BlockIDSDK.IADValidationCallback

• Callback for event when user's account validation is required.

Method Summary

void ifAdValidationRequired(boolean status, ErrorManager.ErrorResponse error, BIDGenericResponse bidGenericResponse, String userID)

• Called when user's account validation is required.

Parameters
status	boolean: Indicates if user's account validation is required
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned
bidGenericResponse	BIDGenericResponse: An optional object of BIDGenericResponse
userID	String: UserID for which the account validation is required

---

IALCallback

public static interface BlockIDSDK.IALCallback

• Callback for event when user's IAL is received.

Method Summary

void onIALResponse(boolean status, String ialValue, ErrorResponse error);

• Called when user's IAL is received.

Parameters
status	boolean: Indicates if user's account validation is required.
ialValue	String: Indicates user's current IAL value.
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

---

ILiveIDEnrollListener

public static interface BlockIDSDK.ILiveIDEnrollListener

• Callback for event when Live ID is enrolled (registered).

Method Summary

void onLiveIDEnrollment(boolean enroll_status, String msg, ErrorManager.ErrorResponse errorResponse)

• Called when Live ID enrollment (registration) is completed.

Parameters
enroll_status	boolean: Indicates if the Live ID is enrolled (registered) or not
msg	String: Error message in case of Live ID enrollment (registered) is failed
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned

---

IVerifyDocumentListener

public static interface BlockIDSDK.IVerifyDocumentListener

• Callback for event when document verification service is used.

Method Summary

void onDocumentVerify(boolean status, String documentVerification, ErrorResponse error)

• Called when application uses document verification service.

Parameters
status	boolean: Indicates if the user is linked or not.
documentVerification	String: Result of document verification.
error	ErrorResponse: In case of error, an object of ErrorResponse is returned

---

KYCCallback

public interface BlockIDSDK.KYCCallback

• Callback for event when KYC has is received.

Method Summary

void onKYCResponse(boolean status, String kycHash, ErrorResponse error)

• Called when application uses KYC Hash.

Parameters
status	boolean: Indicates if the KYV has is generated or not.
documentVerification	String: Result of generated hash.
error	ErrorResponse: In case of error, an object of ErrorResponse is returned.

---

LinkUserCallback

public static interface BlockIDSDK.LinkUserCallback

• Callback for event when user account is linked.

Method Summary

void onLinkedUser(boolean status, ErrorManager.ErrorResponse error)

• Called when user is linked.

Parameters
status	boolean: Indicates if the user is linked or not.
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned

---

MessageGatewaysCallback

public interface BlockIDSDK.MessageGatewaysCallback

• Callback for message gateways.

Method Summary

void onMessageGatewaysResponse(boolean status, ArrayList<MessageGateway> messageGateways, ErrorResponse error)

• Called when requesting a list of gateways

Parameters
status	boolean: Indicates if get Mesasge Gateway successfully completed or errored
messageGateways	ArrayList<MessageGateway>: List of MessageGateway object
error	ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

---

RegisterFIDO2KeyCallback

public static interface BlockIDSDK.RegisterFIDO2KeyCallback

• Callback for event when FIDO2 key is registered.

Method Summary

void onRegisterFIDO2Key(boolean status, ErrorResponse errorResponse)

• Called when FIDO2 key is registered.

Parameters
status	boolean: Indicates if the FIDO2 key is registered or not
error	ErrorResponse: In case of error, an object of ErrorResponse is returned

---

ResetPasswordCallback

public static interface BlockIDSDK.ResetPasswordCallback

• Callback for event when password is reset.

Method Summary

void onPasswordReset(boolean status, ErrorManager.ErrorResponse error)

• Called when password is reset.

Parameters
status	boolean: Indicates if the password is reset or not.
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned

---

SCEPCertificateCallback

public static interface BlockIDSDK.SCEPCertificateCallback

• Callback for SCEP Check

Method Summary

void onSCEPCertificateResponse(boolean status, ErrorResponse error)

Parameters
status	boolean: Indicates if the scep check is successfully completed or errored
error	ErrorResponse: In case of error, an object of ErrorResponse is returned.

---

UnlinkAccountCallback

public static interface BlockIDSDK.UnlinkAccountCallback

• Callback for event when user account is unlinked.

Method Summary

void onUnlinkAccount(boolean status, ErrorManager.ErrorResponse error)

• Called when user account is unlinked.

Parameters
status	boolean: Indicates if the user account is unlinked or not
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned

---

UpdateAccountInfoCallback

public static interface BlockIDSDK.UpdateAccountInfoCallback

• Callback when account information is updated.

Method Summary

void onUpdateAccountInfo(boolean status, ErrorManager.ErrorResponse error)

• Callback when account information is updated.

Parameters
status	boolean: Indicates if the user account is updated or not.
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

---

VCCallback

public static interface BlockIDSDK.VCCallback

• Callback for event when VC data is received.

Method Summary

void onVCResponse(boolean status, String vcData, ErrorManager.ErrorResponse errorResponse)

• Called when VC data is received.

Parameters
status	boolean: Indicates if the user account is unlinked or not.
vcData	String: VC data
errorResponse	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

---

VPCallback

public static interface BlockIDSDK.VPCallback

• Callback for event when VP data is received.

Method Summary

void onVPResponse(boolean status, String vcData, ErrorManager.ErrorResponse error)

• Called when VP data is received.

Parameters
status	boolean: Indicates if the user account is unlinked or not.
result	String: VP data
error	ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.