{"id":22400059,"url":"https://github.com/regulaforensics/facesdk-web-js-client","last_synced_at":"2026-02-19T18:06:11.176Z","repository":{"id":40405148,"uuid":"283497200","full_name":"regulaforensics/FaceSDK-web-js-client","owner":"regulaforensics","description":"Regula Face SDK web API js client for the browser and node.js based on axios ","archived":false,"fork":false,"pushed_at":"2026-02-12T10:27:50.000Z","size":5434,"stargazers_count":6,"open_issues_count":1,"forks_count":4,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2026-02-12T18:59:41.420Z","etag":null,"topics":["face-matching","face-recognition"],"latest_commit_sha":null,"homepage":"https://regulaforensics.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regulaforensics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-07-29T12:47:35.000Z","updated_at":"2026-02-12T10:26:19.000Z","dependencies_parsed_at":"2023-10-25T08:54:58.065Z","dependency_job_id":"eb82d4e8-e7d5-49a6-8d7e-d23c692d6124","html_url":"https://github.com/regulaforensics/FaceSDK-web-js-client","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/regulaforensics/FaceSDK-web-js-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FFaceSDK-web-js-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FFaceSDK-web-js-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FFaceSDK-web-js-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FFaceSDK-web-js-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regulaforensics","download_url":"https://codeload.github.com/regulaforensics/FaceSDK-web-js-client/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FFaceSDK-web-js-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29626712,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-19T18:02:07.722Z","status":"ssl_error","status_checked_at":"2026-02-19T18:01:46.144Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["face-matching","face-recognition"],"created_at":"2024-12-05T08:11:09.705Z","updated_at":"2026-02-19T18:06:11.162Z","avatar_url":"https://github.com/regulaforensics.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Regula FaceSDK js client for the browser and node.js based on axios\n\n[![npm version](https://img.shields.io/npm/v/@regulaforensics/facesdk-webclient?color=yellow\u0026style=flat-square)](https://www.npmjs.com/package/@regulaforensics/facesdk-webclient)\n![npm type definitions](https://img.shields.io/npm/types/typescript?style=flat-square\u0026collor=858df6)\n[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)\n[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-0a8c42?style=flat-square)](https://github.com/regulaforensics/FaceSDK-web-openapi)\n\n\nFace recognition as easy as reading two bytes.\n\n - Face Matching - Compare the person holding the ID to the person pictured in the ID document (1:1)\n - Face Recognition - Find the person by his or her photo in databases / lists (1:N)\n - Liveness Detection - Perform liveness check using a selfie taken with the user’s smartphone.\n\nIf you have any problems with or questions about this client, please contact us\nthrough a [GitHub issue](https://github.com/regulaforensics/FaceSDK-web-js-client/issues).\nYou are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/FaceSDK-web-js-client/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), large or small; We are always thrilled to receive pull requests, and do our best to process them as fast as we can. See [dev guide](./dev.md).\n\n## Install package\n\n```\nnpm install @regulaforensics/facesdk-webclient\n```\n## Example of Face Matching\n\nPerforming request:\n\n```js\nconst face1 = fs.readFileSync('face1.jpg').buffer;\nconst face2 = fs.readFileSync('face2.jpg').buffer;\n\nconst sdk = new FaceSdk({ basePath: 'http://localhost:41101' });\n\nconst response = await sdk.matchApi.match({\n    images: [\n        { type: ImageSource.LIVE, data: face1, index: 1 },\n        { type: ImageSource.DOCUMENT_RFID, data: face2, index: 2 }\n    ]\n  });\n```\n\nParsing results:\n```js\nfor (const result of response.results) {\n    console.log(`pair(${result.firstIndex},${result.secondIndex})   similarity: ${result.similarity}`)\n}\n```\n\nYou can find more detailed guide and run this sample in [example](https://github.com/regulaforensics/FaceSDK-web-js-client/tree/master/examples/basic) folder.\n\n## Compatibility\n\nLanguage level\n* ES5, ES6.Promises - depends on a native ES6 Promise implementation to be supported. If your environment doesn't support ES6 Promises, you can polyfill.\n\nModule system\n* CommonJS\n* ES6 module system\n\nDefinitions\n* TypeScript's definitions should be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#including-declarations-in-your-npm-package))\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Ffacesdk-web-js-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregulaforensics%2Ffacesdk-web-js-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Ffacesdk-web-js-client/lists"}