> 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/help/resources/status-codes.md).

# Status codes

Faceplugin SDK status codes for activate and init (0–4), Linux/Windows HTTP envelope codes, and document verification / image quality fields. Used across Face Recognition, Liveness, and Document SDKs.

Use this page to decode **activate** and **init** results on mobile, HTTP envelope `code` values on Linux and Windows, and document verification fields in OCR JSON.

## Mobile activate / init

Used by Android / iOS / Flutter / React Native / Ionic plugins:

| Code | Constant                     | Meaning             |
| ---: | ---------------------------- | ------------------- |
|    0 | `SDK_SUCCESS` / `sdkSuccess` | Activate or init OK |
|    1 | `SDK_LICENSE_INVALID`        | Invalid license     |
|    2 | `SDK_LICENSE_EXPIRED`        | Expired             |
|    3 | `SDK_NOT_ACTIVATED`          | Not activated       |
|    4 | `SDK_INIT_FAILED`            | Init failed         |

Process methods typically return JSON strings (or typed objects). Serialize native calls.

## Document result codes (normalized JSON)

| Field                  | 0    | 1    | 2           |
| ---------------------- | ---- | ---- | ----------- |
| Verification           | Pass | Fail | Not checked |
| Image QA `CheckResult` | Fail | Pass | Not checked |

## HTTP envelope (shared routes)

| `code` | Typical meaning                                                 |
| -----: | --------------------------------------------------------------- |
|      0 | OK                                                              |
|     -1 | Empty or invalid license; missing required field on some routes |
|    -10 | Not found                                                       |
|    -19 | Unhandled server error                                          |

Process routes often **skip** the envelope and return engine JSON instead.

## Face Liveness server threshold

Score **≥ 0.5** → Real / pass (product README). Change this default only if Faceplugin support gives you a different recommended threshold for your license.

### Related documentation

* [FAQ](/help/resources/faq.md) · [Glossary](/help/resources/glossary.md) · [Troubleshooting](/help/resources/troubleshooting.md) · [Request a License](/help/request-a-license-and-support.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/help/resources/status-codes.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.
