> For the complete documentation index, see [llms.txt](https://docs.1kosmos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.1kosmos.com/mobile-sdk/native/android/api-reference/classes.md).

# Classes

The BlockID SDK for Android provides classes for authentication, document management, enrollment, and data models. This section lists all available classes with a short summary of each. Select a class to view its fields, methods, and usage details.

| Class Name                                                                                                     | Summary                                                                                                                                                                                                                                          |
| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [AccessCodePayload](/mobile-sdk/native/android/api-reference/classes/accesscodepayload.md)                     | Model class to hold Access Code Payload data (attributes)                                                                                                                                                                                        |
| [AccessCodeType](/mobile-sdk/native/android/api-reference/classes/accesscodetype.md)                           | Enum to define and create access code type                                                                                                                                                                                                       |
| [AnalyticsHelper](/mobile-sdk/native/android/api-reference/classes/analyticshelper.md)                         | Helper class to report an events                                                                                                                                                                                                                 |
| [BIDAccount](/mobile-sdk/native/android/api-reference/classes/bidaccount.md)                                   | Model class to represent the user account data (attributes)                                                                                                                                                                                      |
| [BIDAuthProvider](/mobile-sdk/native/android/api-reference/classes/bidauthprovider.md)                         | This class is responsible for managing different authentication types, such as a device's biometric features (fingerprint, face, pin, password, pattern lock), pin and Live ID                                                                   |
| [BIDDocumentDataHolder](/mobile-sdk/native/android/api-reference/classes/biddocumentdataholder.md)             | Model class to hold or represent the Scanned Document Data response (attributes)                                                                                                                                                                 |
| [BIDDocumentProvider](/mobile-sdk/native/android/api-reference/classes/biddocumentprovider.md)                 | This class is responsible for all document management, such as adding or removing identity documents, and other miscellaneous documents                                                                                                          |
| [BIDGenericResponse](/mobile-sdk/native/android/api-reference/classes/bidgenericresponse.md)                   | Model class to represent the generic response object                                                                                                                                                                                             |
| [BIDLinkedAccount](/mobile-sdk/native/android/api-reference/classes/bidlinkedaccount.md)                       | Model class to represent the linked account data (attributes)                                                                                                                                                                                    |
| [BIDOrigin](/mobile-sdk/native/android/api-reference/classes/bidorigin.md)                                     | Model class to represent the origin data (attributes)                                                                                                                                                                                            |
| [BIDPasswordPolicy](/mobile-sdk/native/android/api-reference/classes/bidpasswordpolicy.md)                     | Model class to hold password policy data (attributes).                                                                                                                                                                                           |
| [BIDScannerView](/mobile-sdk/native/android/api-reference/classes/bidscannerview.md)                           | A custom view class to be provided by application. The BIDScannerView is placed on top of Activity from where the document scanner is initiated                                                                                                  |
| [BIDTenant](/mobile-sdk/native/android/api-reference/classes/bidtenant.md)                                     | Model class to represent the tenant data (attributes)                                                                                                                                                                                            |
| [BIDUtil](/mobile-sdk/native/android/api-reference/classes/bidutil.md)                                         | Helper class which allows related methods to be reused                                                                                                                                                                                           |
| [BiometricAssets](/mobile-sdk/native/android/api-reference/classes/biometricassets.md)                         | Helper class to check and determine if the type of biometric assets are enabled for the tenant                                                                                                                                                   |
| [BlockIDSDK](/mobile-sdk/native/android/api-reference/classes/blockidsdk.md)                                   | The primary class and an entry point to the BlockID SDK. Handles initial setup required for the SDK and to access all BlockID SDK features                                                                                                       |
| [CreateAccessCodePayload](/mobile-sdk/native/android/api-reference/classes/createaccesscodepayload.md)         | Model class to hold Create Access Code Payload (attributes)                                                                                                                                                                                      |
| [CreateAccessCodeResponse](/mobile-sdk/native/android/api-reference/classes/createaccesscoderesponse.md)       | Model class to hold Create Access Code Response (attributes)                                                                                                                                                                                     |
| [DigitalAssets](/mobile-sdk/native/android/api-reference/classes/digitalassets.md)                             | Helper class to check and determine if the type of digital document assets are enabled for the tenant                                                                                                                                            |
| [DocumentScannerActivity](/mobile-sdk/native/android/api-reference/classes/documentscanneractivity.md)         | This class is used to start the document scanner and give results back to the application.                                                                                                                                                       |
| [DocumentScannerType](/mobile-sdk/native/android/api-reference/classes/documentscannertype.md)                 | An enum to define document scanner type.                                                                                                                                                                                                         |
| [EmailResult](/mobile-sdk/native/android/api-reference/classes/emailresult.md)                                 | Model class to hold Email Result for created access code                                                                                                                                                                                         |
| [Enrollments](/mobile-sdk/native/android/api-reference/classes/enrollments.md)                                 | Utility class that helps BlockID SDK to determine which biometric (Pin, Live ID) and digital (Drivers License, Passport) assets are supported for each tenant. The Biometric and Digital assets registration is determined by the license module |
| [FacePresenceLevel](/mobile-sdk/native/android/api-reference/classes/facepresencelevel.md)                     | Defines the supported types of document scanners available in the BlockID SDK                                                                                                                                                                    |
| [GetAccessCodeResponse](/mobile-sdk/native/android/api-reference/classes/getaccesscoderesponse.md)             | This class holds the access code response data returned during the access code redemtion flow (attributes)                                                                                                                                       |
| IPProvider                                                                                                     | This class provides a mechanism for fetching and caching the user's IP address from a remote API.                                                                                                                                                |
| [IRFIDScanResponseListener](/mobile-sdk/native/android/api-reference/classes/irfidscanresponselistener.md)     | This class defines methods for callback events related to Passport RFID Scanning.                                                                                                                                                                |
| [LiveIDScannerHelper](/mobile-sdk/native/android/api-reference/classes/liveidscannerhelper.md)                 | Helper class that works with Live ID                                                                                                                                                                                                             |
| [MessageGateway](/mobile-sdk/native/android/api-reference/classes/messagegateway.md)                           | Model class to hold MessageGateway data                                                                                                                                                                                                          |
| [OTPSeedUpdateAction](/mobile-sdk/native/android/api-reference/classes/otpseedupdateaction.md)                 | An enum to define OTP seed update action.                                                                                                                                                                                                        |
| [OTPSeedUpdatedAccountResult](/mobile-sdk/native/android/api-reference/classes/otpseedupdatedaccountresult.md) | Model class to manage OTP Seed Updated Account Result.                                                                                                                                                                                           |
| [PasskeyRequest](/mobile-sdk/native/android/api-reference/classes/passkeyrequest.md)                           | Model class to represent the passkey request data                                                                                                                                                                                                |
| [PasskeyResponse](/mobile-sdk/native/android/api-reference/classes/passkeyresponse.md)                         | Model class to represent the PasskeyResponse data (attributes).                                                                                                                                                                                  |
| [PasswordRules](/mobile-sdk/native/android/api-reference/classes/passwordrules.md)                             | Model class to hold password rules.                                                                                                                                                                                                              |
| [PersonalAssets](/mobile-sdk/native/android/api-reference/classes/personalassets.md)                           | Helper class to check and determine if the type of personal assets are enabled for the tenant                                                                                                                                                    |
| [ProxyDetails](/mobile-sdk/native/android/api-reference/classes/proxydetails.md)                               | Model class to hold proxy information                                                                                                                                                                                                            |
| [QRScannerHelper](/mobile-sdk/native/android/api-reference/classes/qrscannerhelper.md)                         | Helper class that provides QR scanning functionality                                                                                                                                                                                             |
| [RFIDScannerHelper](/mobile-sdk/native/android/api-reference/classes/rfidscannerhelper.md)                     | This helper class handles RFID scanning (E-Passport Chip).                                                                                                                                                                                       |
| [TOTP](/mobile-sdk/native/android/api-reference/classes/totp.md)                                               | Utility class to work with time based OTP feature                                                                                                                                                                                                |
| [Version](/mobile-sdk/native/android/api-reference/classes/version.md)                                         | An enum to define create access code version                                                                                                                                                                                                     |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.1kosmos.com/mobile-sdk/native/android/api-reference/classes.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
