@arkyc/core 1.2.0 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -0
- package/package.json +21 -2
package/README.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# @arkyc/core
|
|
2
|
+
|
|
3
|
+
The deterministic decision engine for [Arkyc](https://github.com/arkstack-hq/arkyc) —
|
|
4
|
+
an open-source, multi-tenant identity-verification platform. Turns verification
|
|
5
|
+
signals (document, OCR, liveness, face match, address) into a risk score and an
|
|
6
|
+
`approved` / `requires_review` / `rejected` verdict, plus the session status
|
|
7
|
+
machine and threshold resolution.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @arkyc/core
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { DecisionEngine } from '@arkyc/core'
|
|
17
|
+
|
|
18
|
+
const { decision, reason, riskScore } = DecisionEngine.decide(signals, thresholds)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Pure and side-effect-free, so the same logic runs in the API and in tests.
|
|
22
|
+
|
|
23
|
+
Docs: <https://docs.arkyc.toneflix.net/guide/architecture>
|
package/package.json
CHANGED
|
@@ -1,8 +1,27 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arkyc/core",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.2",
|
|
4
4
|
"description": "Decision engine, status transitions, and scoring logic",
|
|
5
5
|
"license": "MIT",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"arkyc",
|
|
8
|
+
"kyc",
|
|
9
|
+
"identity-verification",
|
|
10
|
+
"identity",
|
|
11
|
+
"verification",
|
|
12
|
+
"decision-engine",
|
|
13
|
+
"risk-scoring",
|
|
14
|
+
"verification-decisions"
|
|
15
|
+
],
|
|
16
|
+
"homepage": "https://docs.arkyc.toneflix.net",
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "git+https://github.com/arkstack-hq/arkyc.git",
|
|
20
|
+
"directory": "packages/core"
|
|
21
|
+
},
|
|
22
|
+
"bugs": {
|
|
23
|
+
"url": "https://github.com/arkstack-hq/arkyc/issues"
|
|
24
|
+
},
|
|
6
25
|
"type": "module",
|
|
7
26
|
"main": "./dist/index.mjs",
|
|
8
27
|
"module": "./dist/index.mjs",
|
|
@@ -17,7 +36,7 @@
|
|
|
17
36
|
"dist"
|
|
18
37
|
],
|
|
19
38
|
"dependencies": {
|
|
20
|
-
"@arkyc/types": "^1.2.
|
|
39
|
+
"@arkyc/types": "^1.2.2"
|
|
21
40
|
},
|
|
22
41
|
"scripts": {
|
|
23
42
|
"typecheck": "tsc --noEmit",
|