@flonkid/kyc 1.4.0

package/README.md

@@ -0,0 +1,110 @@
+# @flonkid/kyc
+
+Official SDK for [Flonk](https://flonk.id) identity verification.
+
+- **Dashboard**: [dashboard.flonk.id](https://dashboard.flonk.id)
+- **Docs**: [docs.flonk.id](https://docs.flonk.id)
+
+## Install
+
+```bash
+npm install @flonkid/kyc
+```
+
+## Browser — Imperative
+
+```typescript
+import { FlonkKYC } from '@flonkid/kyc';
+
+const kyc = new FlonkKYC();
+const widget = await kyc.init({
+  publishableKey: 'pk_live_...',
+  onSuccess: (result) => console.log('Verified:', result),
+  onError: (err) => console.error(err),
+});
+
+// Later: widget.destroy()
+```
+
+## Browser — React Component
+
+```tsx
+import { FlonkKYCWidget } from '@flonkid/kyc';
+
+function App() {
+  return (
+    <FlonkKYCWidget
+      publishableKey="pk_live_..."
+      onSuccess={(result) => console.log('Verified:', result)}
+      onError={(err) => console.error(err)}
+    />
+  );
+}
+```
+
+### Props
+
+| Prop | Type | Description |
+|------|------|-------------|
+| `publishableKey` | `string` | Client-side key (`pk_live_*` or `pk_sandbox_*`) |
+| `serverUrl` | `string` | Your backend endpoint for session creation |
+| `sessionId` | `string` | Pre-created session ID |
+| `embedToken` | `string` | JWT token from server-to-server flow |
+| `lang` | `'en' \| 'de' \| 'uk'` | Widget language |
+| `onSuccess` | `(result) => void` | Verification completed |
+| `onError` | `(error) => void` | Error occurred |
+| `onCancel` | `() => void` | User closed widget |
+| `onReady` | `() => void` | Widget loaded |
+| `autoOpen` | `boolean` | Open on mount (default: `true`) |
+
+## Server — Node.js
+
+```typescript
+import { FlonkKYCServer } from '@flonkid/kyc/server';
+
+const flonk = new FlonkKYCServer({ secretKey: 'sk_live_...' });
+
+// Create session
+const session = await flonk.sessions.create({
+  clientMetadata: { userId: 'user_123' },
+});
+
+// Verify webhook signature
+const event = flonk.webhooks.constructEvent(rawBody, signature, secret);
+```
+
+## Webhook Events
+
+| Event | Description |
+|-------|-------------|
+| `verification.completed` | AI verification finished |
+| `verification.status_changed` | Admin changed status |
+| `verification.updated` | Admin edited verification data |
+
+```typescript
+const event = flonk.webhooks.constructEvent(rawBody, signature, secret);
+
+switch (event.type) {
+  case 'verification.completed':
+    // Automated decision
+    break;
+  case 'verification.status_changed':
+    // Admin approved/rejected
+    break;
+  case 'verification.updated':
+    // Admin edited extracted data
+    break;
+}
+```
+
+## Links
+
+- [Full Documentation](https://docs.flonk.id)
+- [Dashboard](https://dashboard.flonk.id)
+- [Webhook Guide](https://docs.flonk.id/docs/webhooks)
+- [API Reference](https://docs.flonk.id/docs/api-verification)
+
+## License
+
+Proprietary. Copyright (c) 2026 Flonk. All rights reserved.
+See [Terms of Service](https://flonk.id/terms) for usage terms.