SDK reference

`kyi(mode, scope, accessToken, options?)`

Browser only. Opens the widget and returns a KYIWidget.

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

'drawer'

required

How the widget is displayed.

'kyi' | 'asset-list' | 'wallet-list'

required

Which screen the widget opens on.

string

required

Token generated by your backend.

KYIOptions

Optional callbacks.

Throws if accessToken is empty, or if mode or scope isn’t one of the values above.

`KYIOptions`

Option	Type	Called when
`onReady`	`() => void`	The widget has loaded.
`onClose`	`() => void`	The user closes the widget, or it closes itself.
`onError`	`(error: Error) => void`	The widget reports an error.

`KYIWidget`

Property	Type	Description
`destroy`	`() => void`	Removes the widget immediately. Doesn’t call `onClose`.
`iframe`	`HTMLIFrameElement`	The iframe that hosts the widget.

`generateToken(options)`

Server only, Node.js 18+. Returns a Promise<string> with a signed HS256 JWT.

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

string

required

Your partner ID. Becomes the iss claim.

string

required

Your SECRET_KEY.

string

required

Your internal, stable, never-reused ID for the user. Becomes the sub claim.

number

default:"3600"

Lifetime in seconds.

Throws if issuer, secretKey or userId is empty.

Not using Node.js

Sign an HS256 JWT with your SECRET_KEY and these claims:

token.py

import time, jwt

now = int(time.time())
access_token = jwt.encode(
    {"sub": user.id, "iss": "your-partner-id", "iat": now, "exp": now + 3600},
    BLUPRYNT_SECRET_KEY,
    algorithm="HS256",
)

Types

import type { KYIMode, KYIScope, KYIOptions, KYIWidget } from '@bluprynt/kyi-widget-sdk'

KYI Widget SDK

Public API

Explorer API

`kyi(mode, scope, accessToken, options?)`

`KYIOptions`

`KYIWidget`

`generateToken(options)`

Not using Node.js

Types

​kyi(mode, scope, accessToken, options?)

​KYIOptions

​KYIWidget

​generateToken(options)

​Not using Node.js

​Types

`kyi(mode, scope, accessToken, options?)`

`KYIOptions`

`KYIWidget`

`generateToken(options)`

Not using Node.js

Types