Installation

Prerequisites

• Node.js: 14.x or later
• Package Manager: npm 6.x+ or yarn 1.22.x+
• Project: Browser extension or web project with package.json

Installation

cd your-project-directory
npm install @reclaimprotocol/browser-extension-sdk

Asset Setup

Add the asset setup script to your package.json:

{
  "scripts": {
    "reclaim-extension-setup": "node node_modules/@reclaimprotocol/browser-extension-sdk/build/scripts/install-assets.js --public-dir=public"
  }
}

Run the setup script:

npm run reclaim-extension-setup

This copies pre-built SDK bundles to your public directory:

public/
└── reclaim-browser-extension-sdk/
    ├── content/
    │   ├── content.bundle.js
    │   └── components/
    │       ├── reclaim-provider-verification-popup.css
    │       └── reclaim-provider-verification-popup.html
    ├── offscreen/
    │   ├── offscreen.html
    │   └── offscreen.bundle.js
    └── interceptor/
        ├── network-interceptor.bundle.js
        └── injection-scripts.bundle.js

Verify installation:

ls -la public/reclaim-browser-extension-sdk/

What Gets Installed

Content Script (content.bundle.js)

• Bridges communication between web pages and extension background
• Injected into pages where verification is needed

Offscreen Document (offscreen.html, offscreen.bundle.js)

• Executes WebAssembly for cryptographic proof generation
• Required for Manifest V3 service workers

Network Interceptor (network-interceptor.bundle.js, injection-scripts.bundle.js)

• Monitors network requests during provider verification
• Captures data for proof generation

UI Components (reclaim-provider-verification-popup.*)

• Pre-styled popup for verification flow
• Customizable through CSS

Troubleshooting

Assets not copying?

• Verify --public-dir path matches your project structure
• Check file permissions on the public directory

Module not found?

rm -rf node_modules package-lock.json && npm install

Build errors?

• Ensure SDK assets are in public/, not imported in your code
• Reference via manifest configuration (see next steps)

Get Your API Credentials

Without API credentials, you won't be able to initialize the SDK or create verification requests. This is the most important step after installation.

What You'll Get

• APP_ID: Your unique application identifier
• APP_SECRET: Your application secret key (keep this secure!)

You'll need both of these credentials in the next steps for any integration path you choose.

Next Steps

Choose your integration path:

• Extension Integration → - Build a browser extension
• Web Integration → - Integrate from a website