Introduction

2 min read

The JavaScript SDK, footprint-js, connects your web app to Footprint. It works with any framework or library, such as Angular, React or Vue, and with plain JavaScript. It launches iframes from your site and exchanges secure messages between Footprint and your app.

Browser support

The SDK supports all recent versions of the major browsers. For security, Footprint does not support less popular browsers that no longer receive security updates.

Name	Versions
Chrome	Last 3 major versions
Chrome Mobile	Last 3 major versions
Firefox	Last 3 major versions
Microsoft Edge	Last 3 major versions
Safari OSX	Last 3 major versions
Safari iOS	Last 3 major versions
Android default browser	Last 3 major versions

The SDK depends on native browser features. Polyfilling some of them (for example, the Promises API) can stop footprint.js from working normally. If the SDK does not behave as expected, remove polyfills to see whether they are the cause.

Installation

Install footprint-js version 5 or higher:

bash
1
2npm install @onefootprint/footprint-js

Your app's permissions and content security policy must allow the Footprint integration. See Content Security Policy.

Import the SDK stylesheet so the iframe renders with the correct styles:

javascript
1import "@onefootprint/footprint-js/dist/footprint-js.css";

Next steps

Onboarding (KYC/KYB) launches the onboarding flow and handles its callbacks.
Customization themes and localizes the flow.