Privakey Documentation

Welcome to Privakey's documentation pages. You'll find comprehensive documentation and guides to help you start working with Privakey as quickly as possible. If you can't find the help you need, feel free to reach out to

Get Started    API Reference

Getting Started

The PrivakeyCX Auth Service is a Nodejs server that acts as the core for user challenges and request origin brokering. It is the central hub that connects the App Libraries and any services you wish to benefit from PrivakeyCX features. In addition to handling challenges, the Auth Service also includes a utility used to configure and administer App Spaces, Request Origins, and Users with Devices. For more information about how everything works together, see the Implementation Overview.

To view the API documentation, click here.

Accessing the software

Privakey CX is commercially licensed software. To inquire about gaining access to the Auth Service and other software, please contact

Once you have the required software, proceed to the Deployment Section of the Auth Service guide to learn how to set it up.

Getting Started

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.