biometry-sdk 2.3.6 → 2.3.7
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 +4 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,6 @@ The official JavaScript/TypeScript SDK for integrating [Biometry](https://biomet
|
|
|
11
11
|
- **Face enrollment** — register a user's face from a photo or ID document
|
|
12
12
|
- **Voice enrollment** — register a user's voice for speaker verification
|
|
13
13
|
- **Video processing** — liveness detection, active speaker detection, face recognition, voice recognition, and visual speech recognition in one call
|
|
14
|
-
- **Auto-enrollment** — automatic face and voice enrollment during video processing when both consents are given
|
|
15
14
|
- **Face matching** — compare a reference image against a video to verify identity
|
|
16
15
|
- **Document authentication** — extract and validate data from ID documents (passports, ID cards, etc.)
|
|
17
16
|
- **Full TypeScript support** — ships with complete type definitions
|
|
@@ -46,7 +45,7 @@ The API key is used as a Bearer token for all requests to the Biometry API. An e
|
|
|
46
45
|
|
|
47
46
|
All gateway API responses follow a standard envelope format:
|
|
48
47
|
|
|
49
|
-
```
|
|
48
|
+
```text
|
|
50
49
|
{
|
|
51
50
|
"data": { ... },
|
|
52
51
|
"scoring_result": "pass" | "fail" | "refer" | { ... },
|
|
@@ -686,17 +685,14 @@ Common error scenarios:
|
|
|
686
685
|
|
|
687
686
|
## Examples
|
|
688
687
|
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
- **[React example](./examples/react-example)** — full React app demonstrating SDK initialization, consent, face enrollment, and video processing
|
|
692
|
-
- **[HTML example](./examples/html-example)** — vanilla JavaScript integration without any framework
|
|
688
|
+
If you require additional implementation guidance, please refer to the official API documentation or contact our support team.
|
|
693
689
|
|
|
694
690
|
## License
|
|
695
691
|
|
|
696
|
-
This project is licensed under the MIT License.
|
|
692
|
+
This project is licensed under the MIT License.
|
|
693
|
+
The full license text is available in the source repository.
|
|
697
694
|
|
|
698
695
|
## Support
|
|
699
696
|
|
|
700
697
|
- [Biometry API Documentation](https://developer.biometrysolutions.com/overview/)
|
|
701
|
-
- [GitHub Issues](https://github.com/nicoogamer/biometry-web-sdk/issues)
|
|
702
698
|
- Contact our support team at [support@biometrysolutions.com](mailto:support@biometrysolutions.com)
|