> For the complete documentation index, see [llms.txt](https://doc.faceplugin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.faceplugin.com/products/id-document-recognition-sdk/recognition-and-liveness/server-sdk/id-document-recognition-node-sdk.md).

# Node.js

Faceplugin ID Document Recognition Node.js HTTP API. Same documentProcess routes as Python on port 8082. Optional native libDocSDK; stub without it.

Node.js **HTTP API** with the same routes as the Python Document Reader server (`POST /api/documentProcess`, license routes, …). Default port **8082**. No Docker.

Native `libDocSDK` is optional. Without it the server can run a demo stub (`DOCSDK_STUB=1`) that mimics the Gradio UI shape. For production OCR, use the Python Linux/Windows HTTP SDK or provide the native library.

### Code

{% embed url="<https://github.com/Faceplugin-ltd/ID-Document-Recognition-Node>" %}

### Setup

Sizing: [Hosting requirements](/integration/deploy-and-host/hosting-requirements.md).

```bash
npm start
```

Web demos (React / Vue / Angular / JavaScript) can point at this process on **8082**.

Also public: [Go](https://github.com/Faceplugin-ltd/ID-Document-Recognition-Go) and [C/C++](https://github.com/Faceplugin-ltd/ID-Document-Recognition-CPP) HTTP APIs with the same route family.

### APIs

| Endpoint                        | Purpose                                  |
| ------------------------------- | ---------------------------------------- |
| `GET /api/health`               | Process is listening (no license)        |
| `GET /api/machinecode`          | Machine code                             |
| `GET /api/licenseStatus`        | License status                           |
| `POST /api/activate`            | Activate                                 |
| `POST /api/documentRecognition` | OCR / MRZ / barcode / image quality only |
| `POST /api/documentLiveness`    | Authenticity only                        |
| `POST /api/documentProcess`     | Combined OCR + optional authenticity     |
| `POST /api/generalProcess`      | Single-image general process             |

Full reference: [Document Reader HTTP API](/integration/http-api/document-reader.md). Shared control routes: [Shared endpoints](/integration/http-api/shared.md).

Same route family as the Python Document Reader server. Without native `libDocSDK`, use `DOCSDK_STUB=1` for a demo stub only.

### Related documentation

* [Linux SDK](/products/id-document-recognition-sdk/recognition-and-liveness/server-sdk/id-document-recognition-linux-sdk.md) · [Server SDK](/products/id-document-recognition-sdk/recognition-and-liveness/server-sdk.md) · [Glossary](/help/resources/glossary.md)
* [Document result JSON](/products/id-document-recognition-sdk/document-result-json.md) · [Choose a product](/getting-started/choose-a-product.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 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://doc.faceplugin.com/products/id-document-recognition-sdk/recognition-and-liveness/server-sdk/id-document-recognition-node-sdk.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.