bynn-web-sdk

Bynn Web SDK

The fastest way to put identity verification on a page. The SDK renders the form, creates the session, and opens the verification flow. You provide a public key, a KYC level, and a parent element.

Install

Package manager, which is the path that stays current on its own:

npm install @bynn-intelligence/websdk

import { Bynn } from '@bynn-intelligence/websdk';

Script tag, from a CDN that resolves to the latest published build:

<script src="https://unpkg.com/@bynn-intelligence/websdk/dist/bynn.min.js"></script>

<script type="module">
  import * as Bynn from 'https://unpkg.com/@bynn-intelligence/websdk/dist/bynn.esm.js';
</script>

https://cdn.jsdelivr.net/npm/@bynn-intelligence/websdk/dist/bynn.min.js works the same way if you prefer jsDelivr.

Pinning a version

Pinning is the right call for production, because an unversioned CDN URL means a third party can change your verification flow without a deploy on your side. Bynn serves version-pinned builds at:

https://static.bynn.com/sdk/js/<version>/bynn.min.js
https://static.bynn.com/sdk/js/<version>/bynn.esm.js

Look the current version up rather than copying one. Any of these answers it:

npm view @bynn-intelligence/websdk version
curl -s https://registry.npmjs.org/@bynn-intelligence/websdk/latest | jq -r .version

The dashboard also shows a ready-made snippet with the current version at https://dashboard.bynn.com/integration, under "Bynn.js (easy integration)".

Then pin deliberately and upgrade on your own schedule. A version number written down in a guide is stale the moment a release ships, so treat any version you see quoted anywhere as an example, not as the current one.

Mount

The SDK needs one parent element:

<div id="verification-form"></div>

const bynn = Bynn({
  apiKey: 'your_PUBLIC_api_key',
  kycLevel: 'your_kyc_level',
  parentId: 'verification-form',
  fields: [
    { name: 'first_name',    visible: true },
    { name: 'last_name',     visible: true },
    { name: 'email_address', visible: false, value: '[email protected]' },
    { name: 'phone_number',  visible: true },
    { name: 'unique_id',     visible: false, value: '550e8400-e29b-41d4-a716-446655440000' }
  ]
});

bynn.mount();