# Node JS

You can interact with the Verifiedly API through the use of our Node.js server side library. There are also other third party libraries that are available to use.

# Installation

Installation of the Verifiedly Node.js library is very simple and straight forward.

# Install via NPM

npm install --save verifiedly

# Usage

After installing the library in your project, declare the Verifiedly library at the top of the js file where it will be used.

const verifiedly = require('verifiedly')('YOUR_API_KEY')

# Request Options

While all our services may not be available on our SDKs and Libraries at the same time that they are available on our APIs, here are the requests you can make through our Node.js library.

# 1. Verification Sessions

Verification Sessions are required to initialize the Verifiedly Mobile SDKs and web verification instances.


A session is only valid for 1 hour after it was created. You will not be charged for a session until the verification process has started.

# KYC Session

A KYC session request generates a session and link for a web/mobile individual identity verification instance.

verifiedly.getKycSession().then(response => {
}) .catch(error => {

# KYB Session

A KYB session request generates a session and link for a web/mobile business identity verification instance.

verifiedly.getKybSession().then(response => {
}) .catch(error => {

A successful session request includes the following;

  1. status
  2. session
  3. link

# Status

A status basically informs you of the status of the request.

# Session

A session is what is used to invoke a verification session in whatever environment you choose. Without a session, any request to invoke the verifiedly UI will fail.

A link is also provided incase you want to pass that to your frontend, to allow your user conveniently click on a verification button.

Last Updated: 2/27/2022, 10:10:50 PM