# Welcome

## Welcome to Encedo HEM API

Welcome to Encedo HEM API! Encedo HEM is a commercial version of the Common Criteria certification pending product `Encedo nGINE HSM v1.0`. 

The Encedo HEM is a general-purpose, natively Internet-oriented hardware security module (HSM) that provides advanced key management and basic cryptography functions, operating on the keys it manages. The HEM communicates with host systems through its network interface (Ethernet over a USB connection) and supports RESTful HTTP(s) based API. 

There are two possible configurations (physical implementation) on the market:

* Encedo PPA (Personal Privacy Assistant), USB thumb drive size form factor, and 
* Encedo EPA (Enterprise Privacy Appliance), 19” rack mount network appliance.

![Encedo EPA 4 nodes versions](https://3771065076-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FumangdCzbylA0MhZjLF9%2Fuploads%2FkKbCikhGJaeDwHYfd4PV%2FPGC_1400.jpg?alt=media\&token=330ff393-a24e-4670-af07-f01ae1e54488)

![Encedo PPA in the spotlight](https://3771065076-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FumangdCzbylA0MhZjLF9%2Fuploads%2FYahYiX1ZYg405gINE74p%2FPGC_1323.jpg?alt=media\&token=7796744b-ed3d-465c-ba52-41a0be91c15b)

## The version of this documentation

This documentation is for `Encedo nGINE v.1.0` and is a part of a Common Criteria *"Guidance documentation"* (AGD) and covers all API operations. 

This API is in version v1, and all endpoints, parameters, arguments, return data, or error codes are persistent.

The certified configuration version is listed [here](https://docs.encedo.com/hem-api/~/revisions/1sgifhZ64anc2fyTUTgt/reference/api-reference/system/version-and-status).
\\

\
The certified version of this manual is [here](https://docs.encedo.com/hem-api/~/revisions/1sgifhZ64anc2fyTUTgt/) (Version hash: [1sgifhZ64anc2fyTUTgt](https://github.com/encedo/hem-api-docs/commit/33287dd3de1389dd7b548501f31776fee936331d)).

Version: 1.7b (17.01.2026)

## Disclaimer

Think of Encedo HEM as your digital front-door key. Without it, your most valuable assets remain locked away. DO NOT LEAVE YOUR ENCEDO HEM UNATTENDED.

## Want to jump right in?

Feeling like an eager beaver? Jump into the quick-start docs and get making your first request:

{% content-ref url="preliminary/quick-start" %}
[quick-start](https://docs.encedo.com/hem-api/preliminary/quick-start)
{% endcontent-ref %}

## Want to get general information?

Get general information first before deep diving into API details.

{% content-ref url="preliminary/general-information" %}
[general-information](https://docs.encedo.com/hem-api/preliminary/general-information)
{% endcontent-ref %}

## Want to deep dive?

Dive a little deeper and start exploring our API reference to get an idea of everything that's possible with the API:

{% content-ref url="reference/api-reference" %}
[api-reference](https://docs.encedo.com/hem-api/reference/api-reference)
{% endcontent-ref %}

## Have you found a bug?

Do not hesitate to contact us! Here is how to do this securely.

{% content-ref url="security/report-an-issue" %}
[report-an-issue](https://docs.encedo.com/hem-api/security/report-an-issue)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.encedo.com/hem-api/welcome.md?ask=<question>
```

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.