Guardian JS SDK (@mugshotlabs/guardian-js)

Client-side SDK to initialize the Guardian Fraud Detection Agent and create an identification event from the browser. It returns a request id you can send to your backend to fetch the full event and decide whether to pass or apply additional checks.

Installation

npm install @mugshotlabs/guardian-js
# or
yarn add @mugshotlabs/guardian-js
# or
pnpm add @mugshotlabs/guardian-js

Quick start (npm, ESM)

import { loadAgent } from "@mugshotlabs/guardian-js";

async function main() {
  // Initialize with your site key (debug is optional and can be omitted)
  const api = await loadAgent({ siteKey: "YOUR_SITE_KEY" });

  // Create an identification event and get its request id
  const response = await api.get();
  const body = response && (await response.json());
  const requestId = body?.requestId;

  // Send requestId to your backend to retrieve the full event
  // and decide whether to pass or perform additional checks
}

main();

• Backend SDK: fetch the event by requestId and implement your decisioning with the server SDK: Guardian JS Server SDK on npm

API (client)

• loadAgent({ siteKey: string }) => Promise<Agent>
  • Initializes the browser Agent. debug is optional and not required.
• Agent.get() => Promise<Response | undefined>
  • Creates an identification event and returns a response containing a requestId. Send this requestId to your backend to fetch the event and decide whether to pass or add additional checks.

License

MIT © Mugshot Labs