> 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/authentication/1key-biometric/prerequisites-and-planning.md).

# Prerequisites & Planning

Before deploying 1Key, ensure the following requirements are met.

***

### Network requirements

* **Reachability** to the BlockID tenant and the Auth Server public IP from the end-user machine.
* **Firewall rule** on the Auth Server allowing communication on **port 443** after Auth Server setup.
* **Reachability** to MongoDB from the Auth Server.

### Optional: device firmware upgrades

To upgrade firmware on the 1Key device, ensure reachability to one of the following:

* Keybank server IP: `20.212.64.15`, **or**
* `authx.ensurity.com`

On ports **443** and **30500** (TCP).

### Permissions

* **Administrator permission** for installation on target machines.

### Resources from your vendor

* **1Key Device Template Excel sheet** — used to authorize devices in the Auth Server.
* **1Key devices with unique Keybanks** — Keybanks are loaded onto the devices at manufacturing time. Obtain the loaded Keybank details from the vendor.

### MongoDB

* A **MongoDB connection string**.
* A **service account** with permission to create a database.


---

# 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/authentication/1key-biometric/prerequisites-and-planning.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.