Installing FAD SDK

FAD SDK can be integrated into your project in two ways: as an npm package for modern JavaScript frameworks, or as a standalone JavaScript file for vanilla implementations.

Prerequisites

Before installing FAD SDK, ensure your environment meets these requirements:

Browser Support

Modern browsers with ES6+ support, WebAssembly, and MediaDevices API

HTTPS Required

Camera and media permissions require secure context (HTTPS)

Camera-based modules require browser support for getUserMedia and WebAssembly. Video recording modules additionally require MediaRecorder API support.

Installation Methods

npm
Vanilla JavaScript

npm Installation

Install FAD SDK via npm for use with modern JavaScript frameworks and build tools:

npm install @fad-producto/fad-sdk

Import the SDK

After installation, import the FadSDK class in your JavaScript or TypeScript file:

import FadSDK from '@fad-producto/fad-sdk';

// Check SDK version
console.log(`FAD SDK version: ${FadSDK.version}`);

TypeScript Support

FAD SDK includes TypeScript definitions out of the box:

import FadSDK from '@fad-producto/fad-sdk';

// TypeScript will provide full type checking and autocomplete
const sdk = new FadSDK(token, options);

Using TypeScript? You’ll get full IntelliSense support for all SDK methods, options, and response types.

Vanilla JavaScript Installation

For projects without a build system, use the standalone JavaScript file:

Download the SDK file

Add the fad-sdk.min.js file to your project directory.

project/
├── web-sdk/
│   └── fad-sdk.min.js
└── index.html

Ensure the SDK file is accessible in your application’s public resources directory.

Import as ES6 module

Import the SDK in your JavaScript file using ES6 module syntax:

import FadSDK from './web-sdk/fad-sdk.min.js';

// Check SDK version
console.log(`FAD SDK version: ${FadSDK.version}`);

Configure your HTML

When importing your script from HTML, you must specify type="module":

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>FAD SDK App</title>
  </head>
  <body>
    <!-- Your app content -->
    
    <!-- Import your script as a module -->
    <script src="index.js" type="module"></script>
  </body>
</html>

The type="module" attribute is required when using ES6 imports in vanilla JavaScript. Without it, your imports will fail.

Example Project Structure

my-project/
├── web-sdk/
│   └── fad-sdk.min.js
├── index.html
├── index.js
└── styles.css

Verify Installation

Confirm that FAD SDK is properly installed by checking the version:

import FadSDK from '@fad-producto/fad-sdk';

console.log(`FAD SDK v${FadSDK.version}`);
// Output: FAD SDK v3.0.0

Configuration

After installation, you’ll need to configure the SDK with your credentials.

Environment Setup

FAD SDK supports multiple environments:

import FadSDK from '@fad-producto/fad-sdk';

// Get available environments
const environments = FadSDK.getFadEnvironments();

console.log(environments);
// Available: UATHA, PRODUCTION, etc.

Basic Configuration

Create an SDK instance with your token and options:

import FadSDK from '@fad-producto/fad-sdk';

const token = 'YOUR_API_TOKEN';

const options = {
  environment: FadSDK.getFadEnvironments().UATHA
};

const FAD_SDK = new FadSDK(token, options);

Replace 'YOUR_API_TOKEN' with the actual token provided by your FAD SDK administrator.

Module-Specific Dependencies

Some modules require additional configuration or credentials:

Liveness-3D (FaceTec)

Requires FaceTec credentials:

deviceKeyIdentifier
publicFaceScanEncryptionKey
productionKeyText (domains, expiry date, key)
Optional: baseURL for custom endpoints

Capture-id&R (Regula)

Requires Regula credentials:

API credentials for document processing
Optional: configuration for capture type and data extraction

Capture-id&A (Acuant)

Requires Acuant credentials:

API credentials for document processing
Alert configuration options

Signature Module

Requires configuration for:

Video recording settings
Signature pad customization
Face detection parameters

Browser Compatibility

FAD SDK requires modern browser features:

Feature	Required For	Browser Support
getUserMedia	Camera modules	Chrome 53+, Firefox 36+, Safari 11+
WebAssembly	Camera modules	Chrome 57+, Firefox 52+, Safari 11+
MediaRecorder	Video modules	Chrome 47+, Firefox 25+, Safari 14.1+
ES6 Modules	All modules	Chrome 61+, Firefox 60+, Safari 11+

Camera and microphone access requires HTTPS (secure context) except on localhost. Ensure your application is served over HTTPS in production.

Troubleshooting

Module import fails in vanilla JS

Ensure your script tag includes type="module":

<script src="index.js" type="module"></script>

Camera permission denied

Verify that:

Your site is served over HTTPS
Browser permissions allow camera access
No other application is using the camera

TypeScript errors with npm package

FAD SDK v3.0.0 includes TypeScript definitions. If you encounter issues:

npm install --save-dev @types/node

Version mismatch or undefined

Clear your node_modules and reinstall:

rm -rf node_modules package-lock.json
npm install

Next Steps

Now that FAD SDK is installed, you’re ready to build your first integration:

Quick Start Tutorial

Build a complete identity verification flow

Module Documentation

Explore individual module capabilities

Getting Started

Core Concepts

Modules

Integration Guides

Installation

Installing FAD SDK

Prerequisites

Browser Support

HTTPS Required

Installation Methods

npm Installation

Import the SDK

TypeScript Support

Vanilla JavaScript Installation

Example Project Structure

Verify Installation

Configuration

Environment Setup

Basic Configuration

Module-Specific Dependencies

Browser Compatibility

Troubleshooting

Next Steps

Quick Start Tutorial

Module Documentation

Build docs developers (and LLMs) love

Getting Started

Core Concepts

Modules

Integration Guides

​Installing FAD SDK

​Prerequisites

Browser Support

HTTPS Required

​Installation Methods

​npm Installation

​Import the SDK

​TypeScript Support

​Vanilla JavaScript Installation

​Example Project Structure

​Verify Installation

​Configuration

​Environment Setup

​Basic Configuration

​Module-Specific Dependencies

​Browser Compatibility

​Troubleshooting

​Next Steps

Quick Start Tutorial

Module Documentation

Build docs developers (and LLMs) love

Installing FAD SDK

Prerequisites

Installation Methods

npm Installation

Import the SDK

TypeScript Support

Vanilla JavaScript Installation

Example Project Structure

Verify Installation

Configuration

Environment Setup

Basic Configuration

Module-Specific Dependencies

Browser Compatibility

Troubleshooting

Next Steps