Skip to main content

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​

typeparameter
StringK_WALLET_CREATION
StringK_MESSAGE
StringK_WALLET_GENERATED
StringK_WALLET_GENERATION_FAILED

Method Summary​

nametypeparametersummary
addPreLinkedUservoidaddPreLinkedUser(String userId, BIDOrigin origin, BIDAccount account, LinkUserCallback callback)Provides an option to add already linked user
authenticatePasskeyvoidauthenticatePasskey(@NonNull Activity activity, @NonNull PasskeyRequest passkeyRequest, @NonNull PasskeyCallback callback)Authenticate using passkey
authenticateUservoidauthenticateUser(@Nullable String userId, String sessionId, LinkedHashMap<String, Object> dataObject, String creds, BIDOrigin bidOrigin, String latitude, String longitude, String versionName, String authFactor, AuthenticateUserCallback authenticateUserCallback)Authenticate user with preset data (UWL1.0)
authenticateUservoidauthenticateUser(@Nullable String userId, String sessionId, String sessionUrl, LinkedHashMap<String, Object> dataObject, String creds, BIDOrigin bidOrigin, String latitude, String longitude, String versionName, String authFactor, AuthenticateUserCallback authenticateUserCallback)Authenticate user with preset data (UWL2.0)
authenticateUservoidauthenticateUser(@NonNullContext context, @Nullable String userId, String sessionId, String scopes, String creds, BIDOrigin bidOrigin, String latitude, String longitude, String versionName, HashMap<String, Object> extraData, String authFactor, AuthenticateUserCallback callback)Authenticate user with scope (UWL1.0)
authenticateUservoidauthenticateUser(@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, String authFactor, boolean isRejected, AuthenticateUserCallback callback)Authenticate user with scope (UWL2.0)
checkDeviceFingerPrintEnabledBIDGenericResponsecheckDeviceFingerPrintEnabled()Checks if fingerprint is enabled on device
checkIfDeviceIsSecuredBIDGenericResponsecheckIfDeviceIsSecured()Checks and indicates if keyguard security is enabled in phone device
checkUserExistvoidcheckUserExist(@NonNull String userId, @NonNull BIDOrigin origin, CheckUserExistCallback callback)Checks if the user exists with the given userid and origin.
commitApplicationWalletvoidcommitApplicationWallet()Commits the application's wallet if tenant registration is successful
commitRestorationDatavoidcommitRestorationData()Commits the application's restoration data
createAccesscodevoidcreateAccessCode(CreateAccessCodePayload, AccessCodeCallback callback)Create access for email verification
createDocumentSessionvoidcreateDocumentSession(@NonNull Context context, @NonNull String docType, DocumentSessionCallback callback)Generate Document Scan Session
createDocumentSessionvoidcreateDocumentSession(@NonNull Context context, @NonNull String docType, @Nullable String dvcID, @Nullable String uid, DocumentSessionCallback callback)Generate Document Scan Session
decryptStringStringdecryptString(String inputData, String senderKey)Performs decryption of data with the given public key
encryptStringStringencryptString(String inputData, String rcptKey)Performs encryption of data with the given public key
enrollPinvoidenrollPin(String pin, String proofedBy, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)Register pin for login purpose
fetchCommunityConfigvoidfetchCommunityConfig(@NonNull BIDTenant tenant, @NonNull String keyPath, FetchConfigCallback callback)Fetches and returns Community Level Configurations.
fetchConfigvoidfetchConfig(@NonNull String tenantDns, @NonNull String keyPath, FetchConfigCallback callback)Fetches and returns Global Configurations
fetchUserByUserNamevoidfetchUserByUserName(Context context, BIDTenant tenant, String userName, IFetchUserByUserNameResponseCallback callback)Fetch user account info by user name
fetchDocumentsvoidfetchDocuments(HashMap<String, Object> requestMap, FetchDocumentsCallback callback)Fetches and returns user documents from server
generateNewSessionvoidgenerateNewSession(BIDOrigin origin, String authType, String scopes, GenerateNewSessionListener generateNewSessionListener)Generate new session
getAppTenantBIDTenantgetAppTenant()Returns registered app tenant object.
getBiometricAssetEnrollmentsEnrollments.BiometricAssetsgetBiometricAssetEnrollments()Returns an instance of BiometricAssets class
getCommunityinfovoidgetCommunityInfo(BIDTenant tenant, CommunityInfoCallback callback)Get community information
getCurrentDvcIDstringgetCurrentDvcID()Returns the current DvcID set for the SDK.
getDIDStringgetDID()Get DID of application. DID is a unique Distributed IDentifier
getDigitalAssetEnrollmentsEnrollments.DigitalAssetsgetDigitalAssetEnrollments()Returns an instance of DigitalAssets
getIALvoidgetIAL(IALCallback callback)Returns the current IAL (Identity Assurance Level) of user
getInstancestatic BlockIDSDKgetInstance()Returns an instance of BlockIDSDK
getKYCvoidgetKYC(KYCCallback callback)Get KYC hash
getLicenseModuleBIDGenericResponsegetLicenseModule()Returns license modules setup for given tenant
getLinkedUserListBIDGenericResponsegetLinkedUserList()Returns list of all users linked to DID (Distributed IDentifier)
getLiveIdImageBIDGenericResponsegetLiveIdImage()Returns registered Live ID bitmap image
getMessageGatewaysvoidgetMessageGateways(@NonNull BIDTenant tenant, MessageGatewaysCallback callback)Returns list of message gateways available for given tenant
getMnemonicList<String>getMnemonic()Returns 12 Mnemonic Phrases. Used for the restoration of a wallet in the future
getPersonalAssetEnrollmentsEnrollments.PersonalAssetsgetPersonalAssetEnrollments()Returns an instance of PersonalAssets class
getPasswordPolicyvoidgetPasswordPolicy(@NonNull BIDLinkedAccount account, @NonNull PasswordPolicyCallback callback)Returns password policy for provided Account.
getProxyDetailsProxyDetailsgetProxyDetails()Returns proxy details
getPublicKeyStringgetPublicKey()Returns application wallet's public key
getRemovedAccountListvoidgetRemovedAccountList(UserAccountsRemovedCallback callback)Returns orphan accounts if any are removed
getScopesvoidgetScopes(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)
getSelectedAccountBIDGenericResponsegetSelectedAccount()Returns the selected user account
getServerPublicKeyStringgetServerPublicKey()Returns server public key of registered tenant
getSessionResponsevoidgetSessionResponse(String sessionURL, String sessionId, GetNewSessionListener getNewSessionListener)Get session response for given session URL and sessionID
getTenantBIDTenantgetTenant()Returns root of registered app tenant object
getTOTPBIDGenericResponsegetTOTP()Returns time based OTP value
getTOTPBIDGenericResponsegetTOTP(String otpSeed)Returns time based OTP value based on given OTP seed
getVCvoidgetVC(@NonNull String downloadURL, @NonNull VCCallback callback)Returns VC data from download URL
getVersionStringgetVersion()Returns BlockID SDK version
getVPvoidgetVP(JSONObject vcData, VPCallback callback)Returns VP object based on VC data
initializestatic voidinitialize(Context context)Initializes and creates an instance of BlockIDSDK
initiateWalletvoidinitiateWallet()Initializes and creates application wallet. The wallet contains DID, 12 Mnemonic Phrases, Public Key, and Private Key
isBiometricAssetsEnabledbooleanisBiometricAssetsEnabled()Check and indicates if the biometric assets (Pin, Face ID / Touch ID, Live ID) are registered
isDeviceAuthEnrolledbooleanisDeviceAuthEnrolled()Checks and indicates if user has setup biometric option for login purpose
isDeviceFingerPrintEnableBIDGenericResponseisDeviceFingerPrintEnable()Checks and indicates if user has enabled fingerprint on the device
isDeviceSecureBIDGenericResponseisDeviceSecure(Context context)Checks and indicates if keyguard security is enabled in phone device
isDigitalAssetsEnabledbooleanisDigitalAssetsEnabled()Checks and indicates if digital assets are enabled.
isLiveIDRegisteredbooleanisLiveIDRegistered()Checks and indicates if user has registered Live ID
isPersonalAssetsEnabledbooleanisPersonalAssetsEnabled()Check and indicates if any of the personal assets (email, phone) are enabled.
isPinRegisteredbooleanisPinRegistered()Checks and indicates if user has setup (registered) login Pin
isReadybooleanisReady()Checks and indicates if the SDK is ready for use. BlockIDSDK must be ready before using any functions of SDK
isRestoreModeOnbooleanisRestoreModeOn()Checks and indicates id the restore mode is set to true
isRestoreWalletEnabledvoidisRestoreWalletEnabled(@NonNull String tenantDns,@NonNull RestoreWalletEnabledCallback callback)Returns true/false if Wallet Restoration is enabled or not.
issueJWTOnPasskeyAuthenticationvoidissueJWTOnPasskeyAuthentication(@NonNull Activity activity, @NonNull PasskeyRequest passkeyRequest, @NonNull PasskeyCallback callback)Issue JWT using passkey Authentication.
isTrustedSessionSourcebooleanisTrustedSessionSource(String sessionUrl, TrustedSessionSourceCallback callback)Checks and indicates if the given session URL is trusted by BlockID SDK
pollDocumentSessionvoidpollDocumentSession(@NonNull Context context, @NonNull String sessionId, PollSessionCallback callback)Poll Document Scan Session to get scanned document result.
pollDocumentSessionvoidpollDocumentSession(@NonNull Context context, @NonNull String sessionId, @Nullable String dvcID, PollSessionCallback callback)Poll Document Scan Session to get scanned document result.
redeemAccessCodevoidredeemAccessCode(String code, String lat, String lon, String pushID, String pushProvider, String versionName, AddAccountCallback addAccountCallback)Redeem access code
registerDocumentvoidregisterDocument(Context context, LinkedHashMap<String, Object> dataObject, Bitmap liveIdBitmap, String liveIdProofedBy, String docSignToken, String liveIdSignToken, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)Store (add) the given document data along with Live ID
registerDocumentvoidregisterDocument(Context context, LinkedHashMap<String, Object> dataObject, Bitmap liveIdBitmap, String liveIdProofedBy, String docSignToken, String liveIdSignToken, boolean storeArtifacts, boolean syncArtifacts, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, 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
registerDocumentvoidregisterDocument(Context context, LinkedHashMap dataObject, String signToken, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)Store (add) the given document data
registerDocumentvoidregisterDocument(Context context, LinkedHashMap dataObject, String signToken, boolean storeArtifacts, boolean syncArtifacts, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, 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
registerPasskeyvoidregisterPasskey(@NonNull Activity activity, @NonNull PasskeyRequest passkeyRequest, @NonNull PasskeyCallback callback)Registers passkey
registerPasskeyWithAccountLinkingvoidregisterPasskeyWithAccountLinking(@NonNull Activity activity, @NonNull PasskeyRequest passkeyRequest, @NonNull PasskeyCallback callback)Register passkey with account linking
registerTenantvoidregisterTenant(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
resetPasswordvoidresetPassword(String userID, String password, String newPassword, BIDAccount account, BIDOrigin bidOrigin, ResetPasswordCallback resetPasswordCallback)Resets user's password
resetRestorationDatavoidresetRestorationData()Resets all restoration data
resetSDKvoidresetSDK(String licenseKey, BIDTenant rootTenant, String resetReason)Purges the SDK wallet and all data stored/owned by the SDK
restoreUserDataFromWalletvoidrestoreUserDataFromWallet(IAccountRestoreListener accountRestoreListener)Performs user data restoration from application's wallet
restoreWalletvoidrestoreWallet(List<String> mnemonicPhrase)Returns if the application's wallet is restored
restoreWalletWithLiveIDvoidrestoreWalletWithLiveID(@NonNull Context context, @NonNull String rootTenantDNS, @NonNull String communityName, boolean enableScreenProtection, @NonNull RestoreWalletWithLiveIDCallback callback)Restore the wallet using LiveID
restoreWalletWithLiveIDvoidrestoreWalletWithLiveID(@NonNull Context context, @NonNull String rootTenantDNS, @NonNull String communityName, @NonNull String dvcID, boolean enableScreenProtection, @NonNull RestoreWalletWithLiveIDCallback callback)Restore the wallet using LiveID
setDvcIdvoidsetDvcId(@NonNull String dvcId)Sets application's dvcID (Document Verification Connector Identifier)
setLicenseKeyvoidsetLicenseKey(@NonNull String key)Sets application's license key
setLinkedAccountsJSONvoidsetLinkedAccountsJSON(String acountsJSON)Set Accounts JSON in the SDK's local storage
setLiveIDvoidsetLiveID(Bitmap liveIdBitmap, String proofedBy, String signToken, String livenessResult, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, ILiveIDEnrollListener liveIDResponseListener)Register (store) user's Live ID data
setProxyvoidsetProxy(@NonNull String host, int port, @Nullable String userName, @Nullable String password)Add proxy to all the outbound API calls used within the SDK
setRestoreModevoidsetRestoreMode()Sets user's account restore mode to true
setSelectedAccountvoidsetSelectedAccount(BIDLinkedAccount account)Sets an user's linked account as currently selected account
unenrollPinvoidunenrollPin(BIDDocumentProvider.IDocumentUnEnrollmentListener unEnrollmentListener)Remove (delete) the existing Pin
unlinkAccountvoidunlinkAccount(BIDLinkedAccount linkedAccount, String pushId, String pushProvider, UnlinkAccountCallback callback)Unlink the existing user account
unRegisterDocumentvoidunRegisterDocument(Context context, LinkedHashMap<String, Object> dataObject, BIDDocumentProvider.IDocumentUnEnrollmentListener unEnrollListener)Remove (delete) the existing document
updateAccountInfovoidupdateAccountInfo(@NonNull BIDLinkedAccount account, @NonNull HashMap<String, Object> deviceInfo, @NonNull String pushId, String pushProvider, 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
updateAccountsvoidupdateAccounts(@NonNull List<BIDLinkedAccount> accountList)This function updates the account list stored in SDK local storage
validateAccessCodevoidvalidateAccessCode(String code, BIDOrigin origin, ValidateAccessCodeCallback callback)Check validity of access code.The access code is account redemption code. The access code validation is required before access code redemption.
verifyDocumentvoidverifyDocument(@NonNull LinkedHashMap<String, Object> document, @NonNull String[] verifications, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, @NonNull IVerifyDocumentListener listener)Verify document data that user has presented through BlockID partners
verifyDocumentvoidverifyDocument(@NonNull String dvcID, @NonNull LinkedHashMap<String, Object> document, @NonNull String[] verifications, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, @NonNull IVerifyDocumentListener listener)Verify document data that user has presented through BlockID partners
verifyFaceWithLivenessvoidverifyFaceWithLiveness(Bitmap selfieBitmap, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, BIDAuthProvider.IVerifyFaceWithLivenessCallback callback)Verifies the face against the enrolled LiveID. A liveness check is performed on the provided selfieBitmap, followed by a comparison with the enrolled LiveID.
verifyLiveIDvoidverifyLiveID(Context context, Bitmap bitmap, String signToken, String livenessResult, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, BIDAuthProvider.IFaceComparisonListener listener)Verify Live ID
verifyPinvoidverifyPin(String pin)Returns if the given is verified
verifyUserAccountvoidverifyUserAccount(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, String pushProvider, AddAccountCallback addAccountCallback)Verify user account
emptyOTPSeedsForAccountsvoidemptyOTPSeedsForAccounts(@NonNull EmptyOTPSeedsForAccountsCallback callback)Empty OTPSeeds for Accounts saved.
updateOTPSeedsForAccountsvoidupdateOTPSeedsForAccounts(@NonNull List<BIDLinkedAccount> accounts, @NonNull OTPSeedUpdatedCallback callback)Update OTPSeeds for accounts.
updateOTPSeedForSingleAccountvoidupdateOTPSeedForSingleAccount(@NonNull BIDLinkedAccount account, @NonNull OTPSeedUpdatedCallback callback)Update OTPSeed for a single account.

Method Details​

addPreLinkedUser​

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

  • Provides an option to add already linked user
Parameter
userIdString: UserID of user's account.
originBIDOrigin: User account origin details
accountBIDAccount: An object of BIDAccount.
callbackLinkUserCallback: The block to execute after the response is received

authenticatePasskey​

public void authenticatePasskey(@NonNull Activity activity, @NonNull PasskeyRequest passkeyRequest, @NonNull PasskeyCallback callback)

  • Authenticate using passkey.
Parameter
activityActivity: The current Android Activity context.
passkeyRequestPasskeyRequest: The passkey request object containing BIDTenant, userName, displayName
callbackPasskeyCallback: The block to execute after the response is received.

authenticateUser​

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

  • Authenticate user with preset data (UWL1.0).
Parameter
userIdString: UserID of user's account.
sessionIdString: Session for authentication.
dataObjectLinkedHashMap<String, Object>: Authentication data.
credsString: Credential of user's account.
bidOriginBIDOrigin: Origin details of a user.
latitudeString: Latitude of a user location.
longitudeString: Longitude of a user location.
versionNameString: Application version number
authFactorString: Performed authentication using which authentication type.
authenticateUserCallbackAuthenticateUserCallback: 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, String authFactor, AuthenticateUserCallback authenticateUserCallback)

  • Authenticate user with preset data (UWL2.0).
Parameter
userIdString: UserID of user's account.
sessionIdString: Session for authentication.
sessionUrlString: Complete session URL containing sessionId.
dataObjectLinkedHashMap<String, Object>: Authentication data.
credsString: Credential of user's account.
bidOriginBIDOrigin: Origin details of a user.
latitudeString: Latitude of a user location.
longitudeString: Longitude of a user location.
versionNameString: Application version number
authFactorString: Performed authentication using which authentication type
authenticateUserCallbackAuthenticateUserCallback: 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, String authFactor, AuthenticateUserCallback authenticateUserCallback)

  • Authenticate user with scope (UWL1.0).
Parameter
contextContext: Current activity context.
userIdString: UserID of user's account.
sessionIdString: Session for authentication.
scopesString: Scopes defined for authentication
credsString: Credential of user's account.
bidOriginBIDOrigin: Origin details of user.
latitudeString: Latitude of user's location.
longitudeString: Longitude of user's location.
versionNameString: Application version number
extraDataHashMap<String, Object>: Extra Data which will append with scope data
authFactorString: Performed authentication using which authentication type
authenticateUserCallbackAuthenticateUserCallback: 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, String authFactor, boolean isRejected, AuthenticateUserCallback authenticateUserCallback)

  • Authenticate user with scope (UWL2.0).
Parameter
contextContext: Current activity context.
userIdString: UserID of user's account.
sessionIdString: Session for authentication.
sessionUrlString: Complete session URL containing sessionId.
scopesString: Scopes defined for authentication
metadataLinkedHashMap<String, Object>: Metadata for sign nonce payload
credsString: Credential of user's account.
bidOriginBIDOrigin: Origin details of user.
latitudeString: Latitude of user's location.
longitudeString: Longitude of user's location.
versionNameString: Application version number
extraDataHashMap<String, Object>: Extra Data which will append with scope data
authFactorString: Performed authentication using which authentication type
isRejectedboolean: Indicates whether authentication was rejected.
- If true: Authentication is rejected. The SDK will not resolve scopes and will only return DID, public key, and user ID.
- If false: Authentication is successful, and scopes will be resolved normally.
authenticateUserCallbackAuthenticateUserCallback: The block to execute after the response is received.

checkDeviceFingerPrintEnabled​

public BIDGenericResponse checkDeviceFingerPrintEnabled()

  • Checks if fingerprint is enabled on device

checkIfDeviceIsSecured​

public BIDGenericResponse checkIfDeviceIsSecured()

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

checkUserExist​

public void checkUserExist(@NonNull String userId, @NonNull BIDOrigin origin, CheckUserExistCallback callback)

  • Check if the user exists with the given userid and origin.
ParameterDescription
userIdString: Linked user's account Id.
originBIDOrigin: Origin details.
callbackCheckUserExistCallback: 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(CreateAccessCodePayload payload, AccessCodeCallback callback)

  • Create access for email verification
Parameter
PayloadCreateAccessCodePayload: access code payload
accessCodeCallbackAccessCodeCallback: The block to execute after the response is received.

createDocumentSession​

public void createDocumentSession(@NonNull Context context, @NonNull String docType, DocumentSessionCallback callback)

  • Create Document Scan session
ParameterDescription
contextContext: Activity Context
docTypeString: Type of document
callbackDocumentSessionCallback: The block to execute after the response is received.

createDocumentSession​

public void createDocumentSession(@NonNull Context context, @NonNull String docType, @Nullable String dvcID, @Nullable String uid, DocumentSessionCallback callback)

  • Create Document Scan session.
ParameterDescription
contextContext: Activity Context
docTypeString: Type of document
dvcIdString: Application's dvcID (Document Verification Connector Identifier)
uidString: UID (Unique ID by using it you can filter in AdminX→Verifications).
callbackDocumentSessionCallback: 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
inputDataString: Data to decrypt
senderKeyString: 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
inputDataString: Data to encrypt
senderKeyString: Public key used to encrypt the data

enrollPin​

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

  • Register Pin for login purposes.
Parameter
pinString: Pin to enroll (register)
proofedByString: This identifies the entity responsible for proofing. The default value is “blockid”
enrollListenerBIDDocumentProvider.IDocumentEnrollmentListener: The block to execute after the response is received.

fetchCommunityConfig​

public void fetchCommunityConfig(@NonNull BIDTenant tenant, @NonNull String keyPath, FetchConfigCallback callback)

  • Fetches & returns Community Level Configurations.
Parameter
tenantBIDTenant: Tenant Object
keyPathString: key path (ex. applications.mobile)
callbackFetchConfigCallback: The block to execute after the response is received.

fetchConfig​

public void fetchConfig(@NonNull String tenantDns, @NonNull String keyPath, FetchConfigCallback callback)

  • Fetches & returns Global Configurations
Parameter
tenantDnsString : Tenant DNS.
keyPathString: key path
callbackFetchConfigCallback : 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
requestMapHashMap<String, Object>: Document hashmap to be fetched
callbackFetchDocumentsCallback: The block to execute after the response is received.
RequestMap Parameter
categoriesString[ ]: Document category to fetch (ex. identity_document, misc_document)
idString[ ]: Document ID to fetch
typeString[ ]: Document Type to fetch (ex. dl, ppt, nationalid, ssn)
metadataOnlyboolean

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"]
}

emptyOTPSeedsForAccounts​

public void emptyOTPSeedsForAccounts(@NonNull EmptyOTPSeedsForAccountsCallback callback)

Empty OTPSeeds for Accounts saved.

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

updateOTPSeedsForAccounts​

public void updateOTPSeedsForAccounts(@NonNull List<BIDLinkedAccount> accounts, @NonNull OTPSeedUpdatedCallback callback)

Update OTP seed for list of accounts passed.

Parameter
accountsList<BIDLinkedAccount>: List of BIDLinkedAccount.
callbackOTPSeedUpdatedCallback: The block to execute after the response is received.

updateOTPSeedForSingleAccount​

public void updateOTPSeedForSingleAccount(@NonNull BIDLinkedAccount account, @NonNull OTPSeedUpdatedCallback callback)

Update OTP seed for a single account.

Parameter
accountBIDLinkedAccount: Object for BIDLinkedAccount.
callbackOTPSeedUpdatedCallback: The block to execute after the response is received.

fetchUserByUserName​

public void fetchUserByUserName(Context context, BIDTenant tenant, String userName, IFetchUserByUserNameResponseCallback callback)

  • Fetch user account info by user name
Parameter
contextContext: Activity Context
tenantBIDTenant: BIDTenant Object
userNameString: User Name
callbackIFetchUserByUserNameResponseCallback: The block to execute after the response is received

generateNewSession​

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

  • Generate new session.
Parameter
originBIDOrigin: Origin details
authTypeString: Authentication type
scopesString: Scopes (comma separated) value.
generateNewSessionListenerGenerateNewSessionListener: The block to execute after the response is received
metadataString: metadata value

getAppTenant​

public BIDTenant getAppTenant()

  • Returns registered app tenant object.

getBiometricAssetEnrollments​

public Enrollments.BiometricAssets getBiometricAssetEnrollments()


getCommunityInfo​

public void getCommunityInfo(BIDTenant tenant, CommunityInfoCallback callback)

  • Fetches the community information
Parameter
tenantBIDTenant: Origin details.
callbackCommunityInfoCallback: The block to execute after the response is received.

getCurrentDvcID​

public String getCurrentDvcID()

  • Returns the current DvcID set for the SDK

getDID​

public String getDID()

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

getDigitalAssetEnrollments​

public Enrollments.DigitalAssets getDigitalAssetEnrollments()


getIAL​

public void getIAL(IALCallback callback)

  • Returns the current IAL (Identity Assurance Level) of user.
Parameter
callbackIALCallback : 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
callbackKYCCallback: 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 Bitmap image.

getMessageGateways​

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

  • Returns a list of the message gateways available for the given tenant.
Parameters
tenantBIDTenant: Tenant details.
callbackMessageGatewaysCallback: 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.

getPersonalAssetEnrollments​

public Enrollments.PersonalAssets getPersonalAssetEnrollments()


getPasswordPolicy​

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

Parameters
accountBIDLinkedAccount: Requested account
callbackPasswordPolicyCallback: 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.

getRemovedAccountList​

public void getRemovedAccountList(UserAccountsRemovedCallback callback)

  • Returns any orphan accounts that were removed, if present.
ParameterDescription
callbackUserAccountsRemovedCallback : The block to execute after the response is received.

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
userIdString: UserID of user account
scopesString: Comma separated scopes
credsString: User's credentials
bidoriginBIDOrigin: Origin details of user
latString: Latitude of user's location.
longitudeString: Longitude of user's location.
callbackGetScopeCallback: 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
sessionURLString: Session URL for which response is required.
sessionIdString: SessionID for which response is required.
getNewSessionListenerGetNewSessionListener: The block to execute after the response is received

getTenant​

public BIDTenant getTenant()

  • Returns root of registered app 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
otpSeedString: OTP seed to generate TOTP

getVC​

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

  • Returns VC data from download URL
Parameters
downloadURLString: Issued VC download URL
callbackVCCallback: 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.

Parameter
contextContext: Application context.

getVP​

public void getVP(JSONObject vcData, VPCallback callback)

  • Returns VP object based on VC data
Parameters
vcDataJSONObject: VC Data for which VP has to be created
callbackVPCallback: 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 enabled.

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
contextContext: Activity context

isDigitalAssetsEnabled​

public boolean isDigitalAssetsEnabled()

  • Checks and indicates if digital assets are enabled

isLiveIDRegistered​

public boolean isLiveIDRegistered()

  • Checks and indicates if user has registered Live ID.

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 if the restore mode is set to true.

isRestoreWalletEnabled​

public void isRestoreWalletEnabled(@NonNull String tenantDns, @NonNull RestoreWalletEnabledCallback callback)

  • Returns true/false if Wallet Restoration is enabled or not.
Parameter
tenantDnsString: tenant Dns.
callbackRestoreWalletEnabledCallback: The block executes after the response is received.

issueJWTOnPasskeyAuthentication​

public void issueJWTOnPasskeyAuthentication(@NonNull Activity activity, @NonNull PasskeyRequest passkeyRequest, @NonNull PasskeyCallback callback)

  • Issue JWT using passkey Authentication
Parameter
activityActivity: The current Android Activity context.
passkeyRequestPasskeyRequest: The passkey request object containing BIDTenant, userName
callbackPasskeyCallback: The block to execute after the response is received.

isTrustedSessionSource​

public void isTrustedSessionSource(String sessionUrl, TrustedSessionSourceCallback callback)

  • Checks and indicates if the given session URL is trusted by BlockID SDK.
Parameter
sessionUrlString: Session URL to be verified from list of trusted source
callbackTrustedSessionSourceCallback: Session URL to be verified from list of trusted source.

pollDocumentSession​

public void pollDocumentSession(@NonNull Context context, @NonNull String sessionId, PollSessionCallback callback)

  • Poll Document Scan Session to get scanned document result.
ParameterDescription
contextContext: Activity Context
sessionIdString: Session ID for which polling has to be done
callbackPollSessionCallback: The block to execute after the response is received.

pollDocumentSession​

public void pollDocumentSession(@NonNull Context context, @NonNull String sessionId, @Nullable String dvcID, fetch callback)

  • Poll Document Scan Session to get scanned document result.
ParameterDescription
contextContext: Activity Context
sessionIdString: Session ID for which polling has to be done
dvcIDString: Application's dvcID (Document Verification Connector Identifier).
callbackPollSessionCallback: The block to execute after the response is received.

redeemAccessCode​

public void redeemAccessCode(String code, String lat, String lon, String pushID, String pushProvider, String versionName, AddAccountCallback addAccountCallback)

  • Redeems access code
Parameter
codeString: Access code to be redeem
latString: Latitude of user's location.
lonString: Longitude of user's location.
pushIDString: User's device pushID (push token).
pushProviderString: Push provider (Ex. firebase)
versionNameString: Application version number.
addAccountCallbackAddAccountCallback: 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, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, BIDDocumentProvider.IDocumentEnrollmentListener enrollListener)

  • Store (add) the given document data along with Live ID.
Parameter
contextContext: Current activity context.
dataObjectLinkedHashMap<String, Object>: Document data to be stored
liveIdBitmapBitmap: Live ID image bitmap to be stored.
liveIdProofedByString: The entity responsible for proofing the Live ID (selfie). For BlockID Live ID (selfie) scanner, the default value is “blockid”
docSignTokenString: Signature token of document to verify if the document data is modified or not
liveIdSignTokenString: Signature token of Live ID to verify if the Live ID is modified or not
mobileSessionID@Nullable String: Unique Session ID that can be used for event tracking or validation purposes.
mobileDocumentID@Nullable String: Unique Document ID that can be used for event tracking or validation purposes.
enrollListenerBIDDocumentProvider.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, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, 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
contextContext: Current activity context.
dataObjectLinkedHashMap<String, Object>: Document data to be stored
liveIdBitmapBitmap: Live ID image bitmap to be stored.
liveIdProofedByString: The entity responsible for proofing the Live ID (selfie). For BlockID Live ID (selfie) scanner, the default value is “blockid”
docSignTokenString: Signature token of document to verify if the document data is modified or not
liveIdSignTokenString: Signature token of Live ID to verify if the Live ID is modified or not
storeArtifactsboolean: Flag to indicate if the document must be stored on BlockID platform
syncArtifactsboolean: Flag to indicate if the document must be synced on BlockID platform
mobileSessionID@Nullable String: Unique Session ID that can be used for event tracking or validation purposes.
mobileDocumentID@Nullable String: Unique Document ID that can be used for event tracking or validation purposes.
enrollListenerBIDDocumentProvider.IDocumentEnrollmentListener: The block to execute after the response is received

registerDocument​

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

  • Store (add) the given document data.
Parameter
contextContext: Current activity context.
dataObjectLinkedHashMap<String, Object>: Document data to be stored
signTokenString: Signature token of document to verify if the document data is modified or not
mobileSessionID@Nullable String: Unique Session ID that can be used for event tracking or validation purposes.
mobileDocumentID@Nullable String: Unique Document ID that can be used for event tracking or validation purposes.
enrollListenerBIDDocumentProvider.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, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, 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
contextContext: Current activity context.
dataObjectLinkedHashMap<String, Object>: Document data to be stored
signTokenString: Signature token of document to verify if the document data is modified or not
storeArtifactsboolean: Flag to indicate if the document must be stored on BlockID platform
syncArtifactsboolean: Flag to indicate if the document must be synced on BlockID platform
mobileSessionID@Nullable String: Unique Session ID that can be used for event tracking or validation purposes.
mobileDocumentID@Nullable String: Unique Document ID that can be used for event tracking or validation purposes.
enrollListenerBIDDocumentProvider.IDocumentEnrollmentListener: The block to execute after the response is received

registerPasskey​

public void registerPasskey(@NonNull Activity activity, @NonNull PasskeyRequest passkeyRequest, @NonNull PasskeyCallback callback)

  • Registers passkey
Parameter
activityActivity: The current Android Activity context.
passkeyRequestPasskeyRequest: The passkey request object containing BIDTenant, userName, displayName
callbackPasskeyCallback: The block to execute after the response is received.

registerPasskeyWithAccountLinking​

public void registerPasskey(@NonNull Activity activity, @NonNull PasskeyRequest passkeyRequest, @NonNull PasskeyCallback callback)

  • Registers passkey with account linking
Parameter
activityActivity: The current Android Activity context.
passkeyRequestPasskeyRequest: The passkey request object containing BIDTenant, userName, deviceName
callbackPasskeyCallback: 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
tenantBIDTenant: Tenant details
callbackBIDTenantRegistryCallback: 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
userIDString: Userid of user's account.
passwordString: Current password of user's account.
newPasswordString: New password for user's account.
accountBIDAccount: User's account for which password reset is required
bidOriginBIDOrigin: Origin details of user's account
resetPasswordCallbackResetPasswordCallback: The block to execute after the response is received

resetRestorationData​

public void resetRestorationData()

  • Resets all restoration data.

resetSDK​

public void resetSDK(String licenseKey, BIDTenant rootTenant, String resetReason)

  • Purges the SDK wallet and all data stored/owned by the SDK.
Parameter
licenseKeyString: Application's license key
rootTenantBIDTenant: Tenant object sent by application.
resetReasonString: The reason for which the SDK is being reset.

restoreUserDataFromWallet​

public void restoreUserDataFromWallet(IAccountRestoreListener accountRestoreListener)

  • Performs user data restoration from application's wallet.
Parameter
accountRestoreListenerIAccountRestoreListener: 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
mnemonicPhraseList<String>: List of 12 mnemonic phrases

restoreWalletWithLiveID​

public void restoreWalletWithLiveID(@NonNull Context context, @NonNull String rootTenantDNS, @NonNull String communityName, boolean enableScreenProtection, @NonNull RestoreWalletWithLiveIDCallback callback)

  • Restore the wallet using LiveID
Parameter
contextContext: Context of activity
rootTenantDNSString: Root tenant Dns
communityNameString: Root tenant community
enableScreenProtectionboolean: flag to enable/disable screenshot and screen recording prevention.
callbackRestoreWalletWithLiveIDCallback: The block to execute after the response is received.

restoreWalletWithLiveID​

public void restoreWalletWithLiveID(@NonNull Context context, @NonNull String rootTenantDNS, @NonNull String communityName, @NonNull String dvcID, boolean enableScreenProtection, @NonNull RestoreWalletWithLiveIDCallback callback)

  • Restore the wallet using LiveID.
Parameter
contextContext: Context of activity
rootTenantDNSString: Root tenant Dns
communityNameString: Root tenant community
dvcIDString: Document Verification Connector Identifier.
enableScreenProtectionboolean: flag to enable/disable screenshot and screen recording prevention.
callbackRestoreWalletWithLiveIDCallback: The block to execute after the response is received.

setDvcId​

public void setDvcId(@NonNull String dvcId)

  • Sets application's dvcID (Document Verification Connector Identifier).
Parameter
dvcIdString: Application's dvcID (Document Verification Connector Identifier)

setLicenseKey​

public void setLicenseKey(@NonNull String key)

  • Sets application's license key.
Parameter
keyString: Application's license key

setLinkedAccountsJSON​

public void setLinkedAccountsJSON(String acountsJSON)

  • Set Accounts JSON in the SDK's local storage.
Parameter
accountsJSONString: Accounts JSON string

setLiveID​

public void setLiveID(Bitmap liveIdBitmap, String proofedBy, String signToken, String livenessResult, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, ILiveIDEnrollListener liveIDResponseListener)

  • Register (store) user's Live ID data.
Parameter
liveIdBitmapBitmap: Live ID (Selfie) image
proofedByString: The entity responsible for proofing the Live ID (selfie). For BlockID Live ID (selfie) scanner, the default value is “blockid”
signTokenString: Signature token to verify if the Live ID (selfie) data is modified or not
livenessResultString: JSON String result data of Liveness check.
mobileSessionID@Nullable String: Unique Session ID that can be used for event tracking or validation purposes.
mobileDocumentID@Nullable String: Unique Document ID that can be used for event tracking or validation purposes.
liveIDResponseListenerILiveIDEnrollListener: 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
hostString: The hostname associated with the HTTP proxy
portint: The port number associated with the HTTP proxy
userNameString: The username to be used with the proxy.
passwordString: 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
accountBIDLinkedAccount: User's linked account

unenrollPin​

public void unenrollPin(BIDDocumentProvider.IDocumentUnEnrollmentListener unEnrollmentListener)

  • Remove (delete) the existing Pin.
Parameter
unEnrollmentListenerBIDDocumentProvider.IDocumentUnEnrollmentListener: The block to execute after the response is received

unlinkAccount​

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

  • Unlink the existing user account.
Parameter
linkedAccountBIDLinkedAccount: Currently linked user account.
pushIdString: PushID (push token) of device.
pushProviderString: Push provider (Ex. firebase)
callbackUnlinkAccountCallback: 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
contextContext: Current activity context.
dataObjectLinkedHashMap<String, Object>: Document to be removed.
unEnrollListenerBIDDocumentProvider.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, String pushProvider, 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
accountBIDLinkedAccount : Account
deviceInfoLinkedHashMap<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
pushIdString: Device's push Id
pushProviderString: Push provider (Ex. firebase)
callbackUpdateAccountInfoCallback: The block to execute after the response is received.

updateAccounts​

public void updateAccounts(@NonNull List<BIDLinkedAccount> accountList)

This function updates the account list stored in SDK local storage.

parameter
accountListLists<BIDLinkedAccount>: Accounts List

validateAccessCode​

public void validateAccessCode(String code, BIDOrigin origin, ValidateAccessCodeCallback callback)

  • Check validity of access code. The access code is account redemption code. The access code validation is required before access code redemption.
ParameterDescription
codeString: access code
originBIDOrigin: Access code origin details
callbackValidateAccessCodeCallback: The block to execute after the response is received.

verifyDocument​

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

  • Verify document data that user has presented through partners.
Parameter
documentLinkedHashMap<String, Object>: Hash Map of document data
verificationsString[]: List of verification
mobileSessionID@Nullable String: Unique Session ID that can be used for event tracking or validation purposes.
mobileDocumentID@Nullable String: Unique Document ID that can be used for event tracking or validation purposes.
listenerIVerifyDocumentListener: The block to execute after the response is received

verifyDocument​

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

  • Verify document data that user has presented through partners.
Parameter
dvcIDString: Document Verification Connector Identifier.
documentLinkedHashMap<String, Object>: Hash Map of document data
verificationsString[]: List of verification
mobileSessionID@Nullable String: Unique Session ID that can be used for event tracking or validation purposes.
mobileDocumentID@Nullable String: Unique Document ID that can be used for event tracking or validation purposes.
listenerIVerifyDocumentListener: The block to execute after the response is received

verifyLiveID​

public void verifyLiveID(Context context, Bitmap bitmap, String signToken, String livenessResult, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, BIDAuthProvider.IFaceComparisonListener listener)

  • Verify Live ID.
Parameter
contextContext: Context of activity
bitmapBitmap: Bitmap to compare with enrolled Live ID (selfie)
signTokenString: Signature token to verify if the Live ID (selfie) data is modified or not.
livenessResultString: JSON String result data of Liveness check.
mobileSessionID@Nullable String: Unique Session ID that can be used for event tracking or validation purposes.
mobileDocumentID@Nullable String: Unique Document ID that can be used for event tracking or validation purposes.
listenerBIDAuthProvider.IFaceComparisonListener: The block to execute after the response is received

verifyFaceWithLiveness​

public void verifyFaceWithLiveness(Bitmap selfieBitmap, @Nullable String mobileSessionID, @Nullable String mobileDocumentID, BIDAuthProvider.IVerifyFaceWithLivenessCallback callback)

  • Verifies the face against the enrolled LiveID. A liveness check is performed on the provided selfieBitmap, followed by a comparison with the enrolled LiveID.
ParameterDescription
selfieBitmapBitmap: Bitmap to compare with enrolled Live ID.
mobileSessionID@Nullable String: Unique Session ID that can be used for event tracking or validation purposes.
mobileDocumentID@Nullable String: Unique Document ID that can be used for event tracking or validation purposes.
callbackBIDAuthProvider.IVerifyFaceWithLivenessCallback: The block to execute after the response is received.

verifyPin​

public boolean verifyPin(String pin)

  • Returns if the given PIN is verified.
Parameter
pinString: 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, String pushProvider, AddAccountCallback addAccountCallback)

  • Verify user account.
Parameter
codeString: Access code
userIDString: UserID of user's account.
passwordString: Password of user's account.
phoneNumberString: User's phone number
apiString: Tenant's URL
tagString: Tenant's tag
communityString: Tenant's community name.
versionNameString: Application version number.
latString: Latitude of user's location.
lonString: Longitude of user's location.
device_idString: User's deviceID
pushIDString: User's device pushID (push token).
pushProviderString: Push provider (Ex. firebase).
addAccountCallbackAddAccountCallback: The block to execute after the response is received

Interface Summary​

NameDescription
AccessCodeCallbackCallback for event when access code created.
AddAccountCallbackCallback for event when account is being added.
AuthenticateUserCallbackCallback for event when user has been authentication.
BIDTenantRegistryCallbackCallback for event when application tenant is registered.
CheckUserExistCallbackCallback for event when account existence check is done
CommunityInfoCallbackCallback for event when successful fetch community info.
DocumentSessionCallbackCallback for event when document scan session is fetched.
FetchDocumentsCallbackCallback for event when user's document is fetched.
EmptyOTPSeedsForAccountsCallbackCallback for event when user's accounts OTP seeds are Emptied.
OTPSeedUpdatedCallbackCallback for event when user's accounts OTP Seeds are updated.
FetchConfigCallbackCallback for event when global or community level configs are received.
GenerateNewSessionListenerCallback for event when new session is created (generated).
GetNewSessionListenerCallback for event when new session is received.
GetScopeCallbackCallback for event when scopes are received.
GenerateNewSessionListenerCallback for event when new session is created (generated).
GetNewSessionListenerCallback for event when new session is received.
IAccountRestoreListenerCallback for event when user account is restored.
IALCallbackCallback for event when user IAL is received.
IFetchUserByUserNameResponseCallbackCallback for event when user's account info is fetched.
ILiveIDEnrollListenerCallback for event when Live ID is enrolled (registered).
IVerifyDocumentListenerCallback for event when document verification service is used.
KYCCallbackCallback for event when KYC has is received.
LinkUserCallbackCallback for event when user account is linked.
MessageGatewaysCallbackCallback for get message gateways.
PollSessionCallbackCallback for event when document session polling response is fetched.
PasskeyCallbackThe callback interface to handle the result of the passkey operation.
ResetPasswordCallbackCallback for event when password is reset.
RestoreWalletWithLiveIDCallbackCallback to get is Restore Wallet Enabled.
RestoreWalletEnabledCallbackCallback for event when the restore wallet using LiveID verification is completed.
TrustedSessionSourceCallbackCallback for Trusted session source
UnlinkAccountCallbackCallback for event when user account is unlinked.
UpdateAccountInfoCallbackCallback for event when account information is updated.
UserAccountsRemovedCallbackCallback for event when User Account Remove call completed and returns the removed orphan account list, status and error.
ValidateAccessCodeCallbackCallback for accesscode validation.
VCCallbackCallback for event when VC data is received.
VPCallbackCallback 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
statusboolean: Indicates if the access code is created or not.
createAccessCodeResponseCreateAccessCodeResponse: Access code response
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

AddAccountCallback​

public static interface BlockIDSDK.AddAccountCallback

  • Callback for event when account is being added.

Method Summary​

void onAccountAdded(boolean status, ErrorManager.ErrorResponse error)

  • Called when account is added.
Parameters
statusboolean: Indicates if the account is added or not.
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned

AuthenticateUserCallback​

public static interface BlockIDSDK.AuthenticateUserCallback

  • Callback for event when user has been authenticated.

Method Summary​

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

  • Called when user has been authenticated.
Parameters
statusboolean: Indicates if the user is authenticated or not.
sessionIdString: Returns session id for user authentication.
errorErrorManager.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
statusboolean: Indicates if the user is linked or not.
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned
tenantBIDTenant: An object of BIDTenant being registered

CheckUserExistCallback​

public static interface BlockIDSDK.CheckUserExistCallback

  • Callback for event when account existence check is done.

Method Summary​

void onCheckUserExistCallback(boolean status)

  • Callback for event when account existence check is done.
Parameter
statusboolean: Indicates if the user exists or not.

CommunityInfoCallback​

public interface BlockIDSDK.CommunityInfoCallback

  • Callback for event when successful fetch community info.
Method Summary​

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

  • Callback for event when successful fetch community info.
Parameter
statusboolean: Indicates whether the community info request succeeded
resultString: Json String of Community info
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

DocumentSessionCallback​

public static interface BlockIDSDK.DocumentSessionCallback

  • Callback for event when document scan session is fetched.

Method Summary​

void onDocumentSessionResponse(boolean status, String response, ErrorManager.ErrorResponse error)

  • Callback for event when document scan session is fetched.
Parameters
statusboolean: Indicates if the document scan session is fetched or not.
responseStringDocument scan session response
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.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
statusboolean: Indicates if the user''s document is fetched or not.
resultLinkedHashMap<String, Object>: A Hash-map of user document is returned
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

FetchUserAccountsInfoCallback​

public static interface BlockIDSDK.FetchUserAccountsInfoCallback

Callback for event when user's Account Info is fetched.

Method Summary​

void onFetchUserAccountsInfo(boolean status, ErrorManager.ErrorResponse error,)

Callback for event when user's Account Info is fetched.

Parameters
statusboolean: Indicates if the user's account info is fetched or not.
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

EmptyOTPSeedsForAccountsCallback​

public static interface BlockIDSDK.EmptyOTPSeedsForAccountsCallback

Callback for event when user's Accounts OTP Seeds are emptied.

Method Summary​

void onEmptyOTPSeedsForAccounts(boolean status, ErrorManager.ErrorResponse error)

Callback for event when user's Accounts OTP Seeds are Emptied.

Parameter
statusboolean: Indicates if the user's account info is fetched or not.
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

OTPSeedUpdatedCallback​

public static interface BlockIDSDK.OTPSeedUpdatedCallback

Callback for event when user's Accounts OTP Seeds are Updated.

Method Summary​

void onOTPSeedUpdateCompleted(boolean status, List<OTPSeedUpdatedAccountResult> accountResults, OTPSeedUpdateAction otpSeedUpdateAction)

Callback for event when user's Accounts OTP seeds are updated.

Parameter
statusboolean: Indicates if the user's accounts OTP seeds are updated or not.
accountResultsList<OTPSeedUpdatedAccountResult>: Will get List of object for the success and fail cases.
otpSeedUpdateActionOTPSeedUpdateAction : Will get the action based on Success and Failure cases.

FetchConfigCallback​

public static interface BlockIDSDK.FetchConfigCallback

Callback for event when global or community level configurations are received.

Method Summary​

void onFetchConfigCallback(boolean status, String result, ErrorResponse error);

Parameter
statusboolean: Indicates if config is received or not.
resultString: JSON String Config details are returned.
errorErrorManager.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
statusboolean: Indicates if the new session is created (generated) or not
sessionURLString: Result of new session being received.
resultSessionApi.GenerateNewSessionResponsePayload: A response payload after new session is created (generated)
errorErrorManager.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
responseLinkedHashMap<String, Object> : scopes map.
errorErrorManager.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
statusboolean: Indicates if the new session is received or not
resultString: Result of new session being received.
errorErrorManager.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
statusboolean: Indicates if user account is restored or not.
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned
messageString: Error / Success message

IFetchUserByUserNameResponseCallback​

public static interface BlockIDSDK.IFetchUserByUserNameResponseCallback

  • Callback for event when user's account info is fetched.

Method Summary​

void onFetchUserResponse(boolean status, String response, ErrorResponse error)

Called when user's Account info is received.

Parameters
statusboolean: Indicates if the user's account info is fetched or not.
responseString: JSON String User's Account info
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned

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
statusboolean: Indicates if user's account validation is required.
ialValueString: Indicates user's current IAL value.
errorErrorManager.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_statusboolean: Indicates if the Live ID is enrolled (registered) or not
msgString: Error message in case of Live ID enrollment (registered) is failed
errorErrorManager.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_statusboolean: Indicates if the Live ID is enrolled (registered) or not.
msgString: Error message in case of Live ID enrollment (registered) is failed.
errorErrorManager.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
statusboolean: Indicates if the user is linked or not.
documentVerificationString: Result of document verification.
errorErrorResponse: 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
statusboolean: Indicates if the KYV has is generated or not.
documentVerificationString: Result of generated hash.
errorErrorResponse: 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
statusboolean: Indicates if the user is linked or not.
errorErrorManager.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
statusboolean: Indicates if get Mesasge Gateway successfully completed or errored
messageGatewaysArrayList<MessageGateway>: List of MessageGateway object
errorErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

PasswordPolicyCallback​

public interface BlockIDSDK.PasswordPolicyCallback

  • Callback for get password policy.

Method Summary​

void onPasswordPolicyResponse(boolean status, BIDPasswordPolicy result, ErrorResponse error)

  • Called when get password policy
Parameters
statusboolean: Indicates if get Password Policy successfully completed or errored.
resultBIDPasswordPolicy object
errorErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

PollSessionCallback​

public static interface BlockIDSDK.PollSessionCallback

  • Callback for event when document session polling result is fetched.

Method Summary​

void onPollSessionResponse(boolean status, String response, ErrorManager.ErrorResponse error)

  • Called for event when document session polling result is fetched.
Parameters
statusboolean: Indicates if the password is reset or not.
responseString: Poll Document session Response
errorErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

PasskeyCallback​

public static interface com.onekosmos.blockid.sdk.passKey.PasskeyCallback

  • The callback interface to handle the result of the passkey operation.

Method Summary​

void onPasskeyResponse(boolean status, PasskeyResponse passkeyResponse, ErrorResponse errorResponse);

  • Called when the passkey operation completed (like registerPasskey, authenticatePasskey, registerPasskeyWithAccountLinking, issueJWTOnPasskeyAuthentication)
Parameters
statusboolean: Indicates operation success or fail.
passkeyResponsePasskeyResponse: In case of success, an object of PasskeyResponse is returned.
errorErrorResponse: In case of error, an object of ErrorManager.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
statusboolean: Indicates if the password is reset or not.
errorErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

RestoreWalletEnabledCallback​

public static interface BlockIDSDK.RestoreWalletEnabledCallback

  • Callback to get is Restore Wallet Enabled.

Method Summary​

void onRestoreWalletEnabled(boolean isRestoreWalletEnabled)

  • Called when got response for Restore Wallet Enabled
Parameter
isRestoreWalletEnabledboolean: Indicates if the wallet is restored.

RestoreWalletWithLiveIDCallback​

public static interface BlockIDSDK.RestoreWalletWithLiveIDCallback

Callback for event when the restore wallet using LiveID verification is completed.

Method Summary​

void onRestoreWalletWithLiveIDResponse(boolean status, ErrorResponse error)

Called when the restore wallet using LiveID verification is completed

Parameters
statusboolean: Indicates if the wallet is restored.
errorErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

TrustedSessionSourceCallback​

public static interface BlockIDSDK.TrustedSessionSourceCallback

Callback for Trusted session source

Method Summary​

void onResult(boolean isTrusted)

Parameters
isTrustedboolean: Given session URL is trusted or not

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
statusboolean: Indicates if the user account is unlinked or not.
errorErrorResponse: 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
statusboolean: Indicates if the user account is updated or not.
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned

UserAccountsRemovedCallback​

public static interface BlockIDSDK.UserAccountsRemovedCallback

  • Callback for an event when the User Account Remove call is completed and returns the removed orphan account list, status, and error.

Method Summary​

void onUserAccountsRemoved(boolean status, List<BIDLinkedAccount> removedAccountList, ErrorManager.ErrorResponse error)

  • Callback for event when user account remove call is completed.
Parameter
statusboolean: Indicates if the user account is updated or not.
removedAccountListList<BIDLinkedAccount>: List of removed accounts.
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.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
statusboolean: Indicates if the user account is unlinked or not
errorErrorManager.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
statusboolean: Indicates if the user account is updated or not.
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.

ValidateAccessCodeCallback​

public static interface BlockIDSDK.ValidateAccessCodeCallback

  • Callback for event when VC data is received.

Method Summary​

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

Called when get access ocde validation completed.

Parameters
statusboolean: status of validation
bidGenericResponseBIDGenericResponse: An optional object of BIDGenericResponse
userIDString: UserID for which the access code validated
errorErrorManager.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
statusboolean: Indicates if the user account is unlinked or not.
vcDataString: VC data
errorResponseErrorManager.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
statusboolean: Indicates if the user account is unlinked or not.
resultString: VP data
errorErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned.