# @zenid/websdk

ZenID WebSDK — browser-based document verification, face verification with liveness detection, and license plate recognition.

## Requirements

This package is a client-side component of the **ZenID** identity verification platform. It requires:

- A running **ZenID backend server** with a valid license to start

Without a ZenID backend, the SDK cannot initialize or process any verifications.

## Documentation

Full integration documentation (setup, API reference, migration notes) is available in the manual on your ZenID server:

```
https://<your-zenid-server>/Manual/
```

The manual covers all integration scenarios: downloaded zip, npm package, and Vite/webpack bundler.

## Quick start

```bash
npm install @zenid/websdk
```

```html
<script type="importmap">
  {"imports": {"@zenid/websdk": "./node_modules/@zenid/websdk/dist/index.js"}}
</script>
```

```js
import { ZenidWebController, ZenidBackendApi, SdkVerifierType } from '@zenid/websdk';

const backend = new ZenidBackendApi('https://your-zenid-server/api', 'your-api-key');
const modelsUrl = new URL('./node_modules/@zenid/websdk/models/', window.location.href).href;

await ZenidWebController.Instance.init(backend, modelsUrl);
const result = await ZenidWebController.Instance.verifyAndUpload(SdkVerifierType.Document);
```

## License

Use of this SDK requires a ZenID backend license.