@regulaforensics/facesdk-webclient
TypeScript icon, indicating that this package has built-in type declarations

6.1.1 • Public • Published

Regula FaceSDK js client for the browser and node.js based on axios

npm version npm type definitions documentation OpenAPI

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/facesdk-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 response = await sdk.matchingApi.match({
    images: [
        { type: ImageSource.LIVE, data: face1, index: 1 },
        { type: ImageSource.DOCUMENT_RFID, data: face2, index: 2 }
    ]
  });

Parsing results:

for (const result of response.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)

Package Sidebar

Install

npm i @regulaforensics/facesdk-webclient

Weekly Downloads

860

Version

6.1.1

License

MIT

Unpacked Size

144 kB

Total Files

5

Last publish

Collaborators

  • ivan.hil
  • hleb.albau
  • ikliashchou
  • regula