KYI Widget SDK quickstart

The KYI Widget SDK runs the KYI flow inside your product. Your server mints a short-lived token; your frontend opens the widget in a drawer.

KYI widget drawer showing the asset verification step. — The widget verifying an asset.

Before you start

Send your Bluprynt representative every origin that will embed the widget, such as https://app.example.com and http://localhost:3000. You get back a partner ID and a SECRET_KEY. The widget only loads on allowlisted origins; scheme, host and port must match exactly. The server helper needs Node.js 18 or later.

npm install @bluprynt/kyi-widget-sdk

Mint a token on your server

server.ts

import { generateToken } from '@bluprynt/kyi-widget-sdk/server'

// requireLogin: your own auth middleware
app.post('/api/kyi/token', requireLogin, async (req, res) => {
  const accessToken = await generateToken({
    issuer: process.env.BLUPRYNT_PARTNER_ID, // your partner ID
    secretKey: process.env.BLUPRYNT_SECRET_KEY,
    userId: req.session.user.id, // from the session, never the request body
    expiresIn: 3600, // seconds
  })
  res.json({ accessToken })
})

Keep SECRET_KEY on the server. Take the user ID from your authenticated session: if your endpoint reads it from the request, anyone can open someone else’s verification.

Open the widget

The widget slides in from the right as a drawer. Mint a fresh token each time you open it.

app.ts

import { kyi } from '@bluprynt/kyi-widget-sdk'

const { accessToken } = await fetch('/api/kyi/token', { method: 'POST' })
  .then((r) => r.json())

const widget = kyi('drawer', 'kyi', accessToken, {
  onReady: () => console.log('Widget loaded'),
  onClose: () => console.log('Widget closed'),
  onError: (error) => console.error(error),
})

Pick a scope

Scope	Opens
`kyi`	The full verification flow.
`asset-list`	The member’s verified assets.
`wallet-list`	The member’s verified wallets.

Next: verify the controlling wallets, or see the full reference.

KYI Widget SDK

Public API

Explorer API

KYI Widget SDK quickstart

Before you start

​Before you start

Before you start