@regulaforensics/face-recognition-webclient
v2.1.1
Published
OpenAPI client for face api
Downloads
57
Readme
Regula Face Recognition js client for the browser and node.js based on axios
Face recognition as easy as reading two bytes.
- Face Matching - Compare the person holding the ID to the person pictured in the ID document (1:1)
- Face Recognition - Find the person by his or her photo in databases / lists (1:N)
- Liveness Detection - Perform liveness check using a selfie taken with the user’s smartphone.
If you have any problems with or questions about this client, please contact us through a GitHub issue. You are invited to contribute new features, fixes, or updates, 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.
Install package
npm install @regulaforensics/face-recognition-webclient
Example of Face Matching
Performing request:
const face1 = fs.readFileSync('face1.jpg').buffer
const face2 = fs.readFileSync('face2.jpg').buffer
const sdk = new FaceSdk({basePath: "http://localhost:41101"})
const compareResponse = await sdk.matchingApi.compare({
images: [
{type: ImageSource.LIVE, data: face1, index: 1},
{type: ImageSource.DOCUMENT_RFID, data: face2, index: 2}
]
})
Parsing results:
for (const result of compareResponse.results) {
console.log(`pair(${result.firstIndex},${result.secondIndex}) similarity: ${result.similarity}`)
}
You can find more detailed guide and run this sample in example folder.
Compatibility
Language level
- ES5, ES6.Promises - depends on a native ES6 Promise implementation to be supported. If your environment doesn't support ES6 Promises, you can polyfill.
Module system
- CommonJS
- ES6 module system
Definitions
- TypeScript's definitions should be automatically resolved via
package.json
. (Reference)