Quick start

Prerequisites

Before you begin, make sure you have:

1

Authentication Token

You will need a TOKEN authentication, provided by the Facephi team, to access the SDK.

2

Node.js and package manager

Make sure you have Node.js and NPM (or your preferred package manager) installed on your system.

• Official Node.js website (recommended v20+)

• NPM documentation

3

API Key

Generate your first Integration from the IDV Suite panel, once the Integration is created and published, an associated API Key will be generated. This API Key will be provided by the Facephi Support team.

Basic concepts

SDK Loader

The SDK Loader is a lightweight package that dynamically loads the package @facephi/sdk-web-wc from the CDN at runtime. It automatically creates and configures the element <facephi-sdk-provider> in your application.

Basic usage:

example.ts

import { loadSdk } from '@facephi/sdk-loader';

const sdkElement = await loadSdk({
  apiKey: 'YOUR_APIKEY',
  containerId: 'sdk-container',
});

How it works

When you call loadSdk():

1

The SDK Web Components package is loaded from the CDN.

2

Custom elements are registered in the browser.

3

An element is created <facephi-sdk-provider> with your configuration.

4

The provider is inserted into the container element you specified.

Next steps

Now that you know the basics, you can start integrating the SDK:

• Integration Guide: Step-by-step installation and Integration instructions

• SDK Configuration: Feature configuration options loadSdk

• Integration with Next.js: Guide for Next.js applications

• Programming examples: Collection of sample implementations

For a complete overview of the documentation structure, see the main index.