# Documentation Hub ## Why Keyless? - [Why Keyless?](https://docs.keyless.io/why-keyless/why-keyless.md): This page summarizes our core product capabilities and what makes our proposition unique in the market. - [What can Keyless solve for your business?](https://docs.keyless.io/why-keyless/what-can-keyless-solve-for-your-business.md): This page explains how Keyless achieves genuine identity assurance. - [Keyless Protocol](https://docs.keyless.io/why-keyless/keyless-protocol.md): This page further explains how Keyless is able to use facial biometrics in a truly Privacy-Preserving manner. - [Biometrics Authentication and Liveness detection](https://docs.keyless.io/why-keyless/biometrics-authentication-and-liveness-detection.md): This page explains how Keyless achieves genuine identity assurance. ## Start Here - [Keyless Documentation Hub](https://docs.keyless.io/readme.md): Learn how to use facial biometric authentication in your applications and SSO flows. - [Keyless: an overview](https://docs.keyless.io/keyless-an-overview.md): This page is an introduction to who Keyless are and what we do for businesses today, allowing you to navigate to the right place in our documentation for you. - [Enrollment](https://docs.keyless.io/enrollment.md): This pages explains the two options our customers have to enroll their users on to the Keyless system in order to authenticate their identity on an ongoing basis. - [Authentication](https://docs.keyless.io/authentication.md): This pages explains the use cases and deployment methods for Keyless Authentication and where to find out more about these options. - [Account Recovery](https://docs.keyless.io/account-recovery.md): This page explains the options customers have when using Keyless to support an account recovery process, typically where the user loses access to the device with which they enrolled. ## Mobile SDK - [Keyless SDK Documentation](https://docs.keyless.io/consumer/readme.md): Nothing to remember. Nothing to steal. You are the key. - [Components](https://docs.keyless.io/consumer/introduction/components.md): Learn about the interaction between Keyless components - [Integration Flows](https://docs.keyless.io/consumer/introduction/integration-flows.md): Learn how the Keyless components interact with your app. - [Sample Apps](https://docs.keyless.io/consumer/introduction/sample-apps.md): A description of, and links to, the Keyless sample apps to support integrators with a working example. - [1️⃣ Getting started](https://docs.keyless.io/consumer/mobile-sdk-guide/getting-started.md) - [2️⃣ Enrollment](https://docs.keyless.io/consumer/mobile-sdk-guide/enrollment.md) - [3️⃣ Authentication](https://docs.keyless.io/consumer/mobile-sdk-guide/authentication.md) - [4️⃣ De-Enrollment](https://docs.keyless.io/consumer/mobile-sdk-guide/de-enrollment.md) - [5️⃣ User and device management](https://docs.keyless.io/consumer/mobile-sdk-guide/user-and-device-management.md) - [6️⃣ Secret management](https://docs.keyless.io/consumer/mobile-sdk-guide/user-and-device-management-1.md) - [UI Customization](https://docs.keyless.io/consumer/mobile-sdk-reference/ui-customization.md): The Keyless SDK can be customised in order to provide a more familiar UX when integrated in any custom app. - [Error handling](https://docs.keyless.io/consumer/mobile-sdk-reference/error-handling.md): Common errors, what they mean and recommended next steps. - [Lockout Policy](https://docs.keyless.io/consumer/mobile-sdk-reference/lockout-policy.md): This pages explains how the Lockout Policy works, what the implications are for users and how it is set. - [Liveness Settings](https://docs.keyless.io/consumer/mobile-sdk-reference/liveness-settings.md) - [Logging](https://docs.keyless.io/consumer/mobile-sdk-reference/logging.md): This page explains how customers can leverage the option to log additional data from the mobile SDK for the purpose of performance monitoring, issue investigation and analytics - [JWT signing](https://docs.keyless.io/consumer/mobile-sdk-reference/jwt-signing.md) - [JWT Verification best practise](https://docs.keyless.io/consumer/mobile-sdk-reference/jwt-signing/jwt-verification-best-practise.md): To use a jwks.json endpoint for JWT verification and seamless key rotation, follow this technical workflow. - [PIN authentication](https://docs.keyless.io/consumer/mobile-sdk-reference/pin-authentication.md): Use a PIN to perform specific operations when biometric authentication is not necessary - [Introduce Keyless to Users](https://docs.keyless.io/consumer/mobile-sdk-reference/introduction-screen.md) - [Photo Enrollment](https://docs.keyless.io/consumer/mobile-sdk-reference/photo-enrollment.md): Use a photo (from an identity document) to enroll the initial biometric data of the user - [Generating client state via the Mobile SDK](https://docs.keyless.io/consumer/mobile-sdk-reference/generating-client-state-via-the-mobile-sdk.md): This page explains how to create a client state during a Keyless Enrollment or Authentication, which can then be leveraged for binding a user on a new device. - [Account recovery](https://docs.keyless.io/consumer/mobile-sdk-use-cases/guide-account-recovery.md): This page explains what we mean by account recovery and the context you may need to integrate it. - [New Device Activation](https://docs.keyless.io/consumer/mobile-sdk-use-cases/guide-account-recovery/new-device-activation.md): This page explains how to then use the client state to then authenticate the user and bind the new device to then support ongoing 2 factor authentication. - [Dynamic Linking](https://docs.keyless.io/consumer/mobile-sdk-use-cases/guide-sca-dynamic-linking.md) - [Changelog](https://docs.keyless.io/consumer/mobile-sdk-changelog/changelog.md) - [Getting Started](https://docs.keyless.io/consumer/server-api/getting-started.md): This API allows for backend-to-backend communication between your backend and the Keyless servers. - [Users](https://docs.keyless.io/consumer/server-api/users.md): This set of API calls allows you to make operations on various Keyless users. - [External User ID](https://docs.keyless.io/consumer/server-api/external-users.md): This set of API calls allows you to perform operations to Create, Modify, Delete and Retrieve External User IDs - [Devices](https://docs.keyless.io/consumer/server-api/devices.md): This set of API calls allows you to fetch and manipulate Keyless enabled devices. - [Operations](https://docs.keyless.io/consumer/server-api/operations.md): This set of API calls allows you to fetch operations on various Keyless entities. - [Telemetry](https://docs.keyless.io/consumer/server-api/telemetry.md): This API calls allows you to retrieve meta data related to a user or specific transaction. ## Web SDK - [Keyless Web SDK Documentation](https://docs.keyless.io/web-sdk/keyless-web-sdk-documentation.md): Authenticate people, not just devices - [Components](https://docs.keyless.io/web-sdk/introduction/components.md): Learn about the interaction between Keyless components - [Integration Flows](https://docs.keyless.io/web-sdk/introduction/integration-flows.md): Learn how the Keyless components interact with your app. - [Getting Started](https://docs.keyless.io/web-sdk/web-sdk-guide/getting-started.md) - [Prerequisites](https://docs.keyless.io/web-sdk/web-sdk-guide/prerequisites.md) - [Enrollment](https://docs.keyless.io/web-sdk/web-sdk-guide/enrollment.md) - [Authentication](https://docs.keyless.io/web-sdk/web-sdk-guide/authentication.md) - [Browser Requirements](https://docs.keyless.io/web-sdk/web-sdk-guide/browser-requirements.md) - [UI Customization](https://docs.keyless.io/web-sdk/web-sdk-reference/ui-customization.md) - [Localization](https://docs.keyless.io/web-sdk/web-sdk-reference/localization.md) - [Lockout Policy](https://docs.keyless.io/web-sdk/web-sdk-reference/lockout-policy.md): This pages explains how the Lockout Policy works, what the implications are for users and how it is set. - [Error Handling](https://docs.keyless.io/web-sdk/web-sdk-reference/error-handling.md) - [Camera Permission Flow](https://docs.keyless.io/web-sdk/web-sdk-reference/camera-permission-flow.md) - [Signing Transactions](https://docs.keyless.io/web-sdk/web-sdk-reference/signing-transactions.md) - [Add OperationID to an authentication](https://docs.keyless.io/web-sdk/web-sdk-reference/add-operationid-to-an-authentication.md) - [Multi-Threading](https://docs.keyless.io/web-sdk/web-sdk-reference/multi-threading.md) - [User Authorization](https://docs.keyless.io/web-sdk/web-sdk-reference/user-authorization.md) - [Changelog](https://docs.keyless.io/web-sdk/web-sdk-changelog/changelog.md) ## IDV Bridge - [IDV Bridge overview](https://docs.keyless.io/idv-bridge/readme.md): Enroll new and existing users into Keyless with a selfie, portrait or documented collected from outside of Keyless. - [IDV Bridge On-Premise](https://docs.keyless.io/idv-bridge/readme/idv-bridge-on-premise.md): This page covers the fundamentals that customers need be aware of when installing Keyless Agent - the IDV Bridge On-Premise solution. - [Keyless Agent Endpoints](https://docs.keyless.io/idv-bridge/readme/idv-bridge-on-premise/keyless-agent-endpoints.md) - [How to Run Keyless Agent](https://docs.keyless.io/idv-bridge/readme/idv-bridge-on-premise/how-to-run-keyless-agent.md): This page talks through how to set-up and run IDV Bridge On-Premise (Keyless agent) and the required configurations. - [Changelog](https://docs.keyless.io/idv-bridge/readme/idv-bridge-on-premise/changelog.md): Details of IDV Bridge On-Premise (Keyless Agent) releases - [Keyless On-Premise enrollment -> Web SDK authentication tutorial](https://docs.keyless.io/idv-bridge/readme/idv-bridge-on-premise/keyless-on-premise-enrollment-greater-than-web-sdk-authentication-tutorial.md): This page is a tutorial for integrators who want to enroll user selfies via IDV Bridge On-Premise and then allow those same users to authenticate on their web app via our SDK - [IDV Bridge SaaS](https://docs.keyless.io/idv-bridge/readme/idv-bridge-saas.md): Enroll user images via an API in order to facilitate on-going authentication via our Mobile or Web SDK. - [Encrypting images and Keys - Java examples](https://docs.keyless.io/idv-bridge/readme/idv-bridge-saas/encrypting-images-and-keys-java-examples.md) - [Exporting the client state to Authenticate the enrolled user](https://docs.keyless.io/idv-bridge/readme/idv-bridge-saas/exporting-the-client-state-to-authenticate-the-enrolled-user.md): Having successfully enrolled a user via IDV Bridge SaaS, it is critical that integrators export the client state to support account recovery and ongoing authentication via the Mobile SDK - [Component interoperability](https://docs.keyless.io/idv-bridge/component-interoperability.md): This page outlines how customers can allow users to authenticate on different platforms (web/mobile) regardless of which component they initially enroll from by leveraging client state. ## User Guide - [Install Mobile App](https://docs.keyless.io/userguide/readme.md): Download and Install the app on your iPhone or Android Device - [Add Account](https://docs.keyless.io/userguide/using-the-mobile-app/link-account.md): Add your first account by scanning a QR code. - [Enable Backup](https://docs.keyless.io/userguide/using-the-mobile-app/enabling-backups.md) - [Delete Account](https://docs.keyless.io/userguide/using-the-mobile-app/de-enroll.md): Delete your Keyless Authenticator Account - [Authentication](https://docs.keyless.io/userguide/using-the-mobile-app/authenticate.md): Authenticate using the Keyless Authenticator - [Windows Login](https://docs.keyless.io/userguide/using-the-mobile-app/authenticate/windows-authentication.md): Learn how to authentication to Windows Workstation - [RDP Authentication](https://docs.keyless.io/userguide/using-the-mobile-app/authenticate/rdp-authentication.md): Learn how to authenticate to desktops using RDP. - [Troubleshooting](https://docs.keyless.io/userguide/using-the-mobile-app/troubleshooting.md): How to troubleshoot common issues - [Android Troubleshooting](https://docs.keyless.io/userguide/using-the-mobile-app/troubleshooting/android-troubleshooting.md): Keyless Authenticator on Android - [iOS Troubleshooting](https://docs.keyless.io/userguide/using-the-mobile-app/troubleshooting/ios-troubleshooting.md): Keyless Authenticator on iOS ## On-Premise - [On-Premise Installation Manual](https://docs.keyless.io/on-premise/on-premise-installation-manual.md): Zero-Knowledge Biometrics™ - [Planning for installation](https://docs.keyless.io/on-premise/keyless-backend-installation/planning-for-installation.md) - [Components](https://docs.keyless.io/on-premise/keyless-backend-installation/components.md) - [Infrastructural requirements](https://docs.keyless.io/on-premise/infrastructural-requirements.md) - [Monitoring](https://docs.keyless.io/on-premise/monitoring.md) - [Installation procedure](https://docs.keyless.io/on-premise/installation-procedure.md) - [General Configuration](https://docs.keyless.io/on-premise/installation-procedure/general-configuration.md) - [Namespace](https://docs.keyless.io/on-premise/installation-procedure/namespace.md) - [Helm setup](https://docs.keyless.io/on-premise/installation-procedure/helm-setup.md) - [Core Daemon](https://docs.keyless.io/on-premise/installation-procedure/core-daemon.md) - [Metrics Collector](https://docs.keyless.io/on-premise/installation-procedure/metrics-collector.md) - [Operations Service](https://docs.keyless.io/on-premise/installation-procedure/operations-service.md) - [Administrator Dashboard](https://docs.keyless.io/on-premise/installation-procedure/administrator-dashboard.md) - [Upgrade procedure](https://docs.keyless.io/on-premise/upgrade-procedure.md) - [Cluster and Runtime](https://docs.keyless.io/on-premise/upgrade-procedure/cluster-and-runtime.md) - [Breaking changes](https://docs.keyless.io/on-premise/upgrade-procedure/cluster-and-runtime/breaking-changes.md) - [Release 1.3.0](https://docs.keyless.io/on-premise/upgrade-procedure/cluster-and-runtime/breaking-changes/release-1.3.0.md) - [Release 1.4.0](https://docs.keyless.io/on-premise/upgrade-procedure/cluster-and-runtime/breaking-changes/release-1.4.0.md) - [Databases](https://docs.keyless.io/on-premise/upgrade-procedure/databases.md) - [Checking the installation completed successfully](https://docs.keyless.io/on-premise/checking-the-installation-completed-successfully.md) - [Helm and Components Versions](https://docs.keyless.io/on-premise/helm-and-components-versions.md) ## Mobile Document SDK - [Mobile Document SDK](https://docs.keyless.io/mobile-document-sdk/readme.md): Verify identity to enroll extracted user selfies ready for ongoing facial biometric authentication. - [Overview](https://docs.keyless.io/mobile-document-sdk/introduction/overview.md) - [1️⃣ Getting started](https://docs.keyless.io/mobile-document-sdk/mobile-document-sdk-guide/1-getting-started.md) - [2️⃣ Read MRZ](https://docs.keyless.io/mobile-document-sdk/mobile-document-sdk-guide/2-read-mrz.md) - [3️⃣ Read NFC](https://docs.keyless.io/mobile-document-sdk/mobile-document-sdk-guide/3-read-nfc.md) - [4️⃣ Scan Document](https://docs.keyless.io/mobile-document-sdk/mobile-document-sdk-guide/4-scan-document.md) - [Enroll from the document photo](https://docs.keyless.io/mobile-document-sdk/mobile-document-sdk-use-cases/enroll-from-photo.md) --- # 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, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.keyless.io/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.