node package manager
We need your input. Help make JavaScript better: Take the 2017 JavaScript Ecosystem survey »



Install the 'oneid' package using NPM.


npm install oneid


Include the 'oneid' package in your Node application.

var oneid = require('oneid');

If you've already obtained OneID API credentials, create your client using the oneid.getClient() method.

var client = oneid.getClient(API_ID, API_KEY)

Otherwise, don't use any parameters and then use the register() method to generate some fresh credentials.

var client = oneid.getClient()
client.register(function(response) {
  // {
  //   "API_KEY": "noscJaqlagYS/cDAijsbNr==",
  //   "API_ID": "cf438e4e-a7d0-49f4-b85e-6182ec3704cb"
  // }
  client.setCredentials(response.API_ID, response.API_KEY)

Then set up a route in your Node application that matches the challenge callback used by the OneID JavaScript API.'/auth', function(req, res) {
  client.validate(req.body, function(oneid_res) {
    if (oneid_res.isValid()) {
      // save or update user record here
        errorcode: 0,
        error: "success",
        valid: true
    else {
        errorcode: -99,
        error: oneid_res.getResponse() || "login not authorized",
        valid: false