Skip to main content

Welcome to Berify Docs

This document provides explanations for third-party login, user management system, scan data, app information, tag-related operations, and identity verification functions.

Register and Apply for Your API Key and Secret Key​

To start accessing BerifyAPI, you'll first need to apply for an API Key ID. Please reach out to our team via email at support@berify.io to request your API Key ID. Once your request is approved, we will provide you with a unique API Key ID.

In addition to the API Key ID, you'll also require a secret key to configure the package within your application. This secret key will be provided to you by our team along with your API Key ID.

What you'll need​

  • Node.js version 18.0 or above :
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Install and Configure​

npm i @bytexbyte/berify-app-open-api

After installing the package, you'll need to configure it with your API credentials. Here's how you can set it up :

import BerifyAppApi from '@bytexbyte/berify-app-open-api';

// Initialize the API client with your credentials
const berifyAppApi = new BerifyAppApi({
  host: 'YOUR_DOMAIN_NAME', // (For testing, please use https://sandbox-staging-app.berify.io)
  env: '/path/to/your/environment', // Specify your environment if needed
  secretKey: 'App-Berify-Secret', // Do not modify
  secret: 'YOUR_SECRET_HERE' // This is the secret key provided by Berify
});

To obtain the secret key required for the configuration, please reach out to our team via email at support@berify.io to request your secret key.

Once you have obtained the secret key from Berify, replace 'YOUR_SECRET_HERE' with the actual secret key provided to you.

After configuring the API client, you can start using the Berify API to access its features and services.