ivalt-api-js

iValt JS SDK

iValt Api - JavaScript client for accessing iValt Biometric Authentication APIs. Identify Anyone, From Anywhere for Any Application. See this npm package in action at https://ondemandid.com

• API version: 1.0
• Package version: 1.0

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install ivalt-api-js --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Request an API Key

iValt APIs require a client api key. You may request a key by sending a request on our contact form: https://ivalt.com/contact-us.php

Getting Started

Please follow the instructions below and execute the following JS code:

var IValtApi = require('ivalt-api-js');
var defaultClient = IValtApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token"

var api = new IValtApi.DefaultApi()
var mobile = "phone-number"; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.biometricAuthRequest(mobile, callback);

Documentation for API Endpoints

All URIs are relative to https://ivalt.com

Class	Method	HTTP request	Description
IValtApi.DefaultApi	biometricAuthRequest	POST /services/ivalt_backend/public/send/global/notification	Initiate a biometric auth request
IValtApi.DefaultApi	biometricResultRequest	POST /services/ivalt_backend/public/validate/auth	Results of a biometric auth request

Documentation for Models

• IValtApi.BiometricAuthRequest
• IValtApi.BiometricResultRequest
• IValtApi.InlineResponse200
• IValtApi.InlineResponse2001
• IValtApi.InlineResponse200Result
• IValtApi.InlineResponse200Results
• IValtApi.InlineResponseDefault

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header