Headless M-Pin Client Library

Requirement for build & testing

  1. Nodejs
  2. Grunt
  3. Mocha
  4. Bower


$ git clone
$ cd project_folder
$ npm install
$ grunt build

Simple usage example

  • Registration
var mpin = mpinjs({server: <serverIP-and-port>});



mpin.startRegistration(<userId>, <callback>);

/* Wait for end-user to confirm identity */

mpin.confirmRegistration(<userId>, <callback>);

/* If successful, read desired user secret (PIN or password) */

mpin.finishRegistration(<userId>, <user-secret>);

  • Authentication
mpin.startAuthentication(<userId>, <callback>);

/* If successful, read user secret (PIN or password) */

mpin.finishAuthentication(<userId>, <user-secret>, <callback>);
  • Authentication with a mobile device

/* Display Access number to end user */

mpin.waitForMobileAuth(<timeout-sec>, <retry-period-sec>, <callback>);

   If successfull - Authentication completed
   If exits with timeout, then no successfull authentication from mobile device was completed
   If one needs to cancel the waiting for authentication from the mobile device, call cancelMobileAuth()

Running Tests

Install development dependencies:

$ npm install


$ npm test

Actively tested with node:

  • 0.10.4