Eid-commons NPM

EID commons

WE SUGGEST THE USAGE OF TYPESCRIPT TO USE OUR TYPE DEFINITIONS AND EXTENDED DOCUMENTATION

For a practical demonstration of this library please check our web showcase out, with your sandbox API TOKEN.

Getting started

To start using eid-commons, you'll need to install it via npm (npm i eid-commons -S) once it has finished installing, you'll need to write to following code to inject our SDK scripts: ^1

^1 this is no longer necessary since our api scripts take in an optional einvironment parameter, but we do recommend this approach since it takes less time.

  import { sandbox } from 'eid-commons/conf/endpoints';
  import eid from 'eid-commons';
  eid.initEID(sandbox);

This code will inject all of our sdk scripts in the <head> of your document. If you only require from a single of our sdks, you can load only the necessary ones via:

  import { apis, live } from 'eid-commons/conf/endpoints';
  import eid from 'eid-commons';
  eid.setEnv(live);
  eid.initEIDEndpoint(apis.videoID);

if evertthing went fine You'll now require to get your one time authorization from your database if you don't have a token and want to use our technologies, please request one. ^2

^2 this token is set globally to be saved on a safe back-end, not in the front-end visit our website to request one.

Our apis

A step by step guide to using all of our apis

- VideoId

to begin using videoId you'll need to write the following import:

import VideoID from 'eid-commons/api/videoID';

this will yield an object with the following structure: ^3

^3 all of thhe inner fields are exported as independent functions, instead of belonging to a class, and they can be imported individually from their respective routes import VideoID from 'eid-commons/dist/lib/api/videoID/'.

const videoID = {
  substantial,
  medium,
};

VideoID substantial:

Your go-to unattended video identification, it requires a token but not a registration authority to be performed.

HTML:

<div id="video" style="width: 100vw; height: 100vh;"></div>
<!-- please remember to set your width and height>

JS/TS:

import VideoID from 'eid-commons/api/videoID';
  VideoID.substantial(
    'video',
    MY_AUTH,
    {
      lang: 'en',
      idType: 62, //<------- spanish nif number
      destroy: true //<------ optional, true by default
    }
    ).then((res) => {
    const video = res.response;
    const videoId = res.element;
    /* your response code here */
    });
  }),
    (err) => {
      const videoId = err.element;
      /* your error code here */
    };

VideoID.substantial takes in the id of the tag to be used as the video container, your auth, and two optional parameters, one to specify thelanguage, identity document type, and if the videoID element is to be destroyed automtically or not, if it is undefined will be returned instead of the element.

VideoID medium:

Your (simpler) go-to unattended video identification, it has the same requirements as videoId substantial, but it will not perform face recognition.

HTML:

<div id="video" style="width: 100vw; height: 100vh;"></div>
<!-- please remember to set your width and height>

JS/TS:

import VideoID from 'eid-commons/api/videoID';
  VideoID.medium(
    'video',
    MY_AUTH,
    {
      lang: 'en',
      idType: 62, //<------- spanish nif number
      destroy: true //<------ optional, true by default
    }
    ).then((res) => {
    const video = res.response;
    const videoScan = res.element;
    /* your response code here */
    });
  }),
    (err) => {
      const videoScan = err.element;
      /* your error code here */
    };

VideoID.medium takes in the id of the tag to be used as the video container, your auth, and two optional parameters, one to specify the language, identity document type, and if the videoScan element is to be destroyed automtically or not, if it is, undefined will be returned instead of the element.

axios

@infinitebrahmanuniverse/nolb-ei @zalastax/nolb-ei

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago