Skip to main content
@keverdjs/agent (vanilla JavaScript). For React use @keverdjs/react, Vue @keverdjs/vue, Angular @keverdjs/angular.

Keverd.init(apiKey | config)

Initialize the SDK. Call once before get(). Parameters:
OptionTypeRequiredDescription
apiKeystringYesYour public API key (pk_live_ or pk_test_)
endpointstringNoBackend URL; default https://api.keverd.com
userIdstringNoUser identifier to attach to requests
debugbooleanNoEnable debug logs; default false
Examples:
javascript
Keverd.init('YOUR_PUBLIC_API_KEY');

Keverd.init({ apiKey: 'YOUR_PUBLIC_API_KEY', endpoint: 'https://api.keverd.com', debug: false });

Keverd.get()

Collect device/visitor data and return a result. Call on page load or at key events (login, checkout). Returns: Promise<GetResult> Example:
javascript
const result = await Keverd.get();
console.log(result.event_id, result.visitor_id);

GetResult

PropertyTypeDescription
event_idstringUnique ID for this request/event
visitor_idstringPersistent device/visitor identifier
risk_scorenumberRisk score (0–100), when available
actionstring'allow', 'challenge', or 'block', when available
reasonstring[]Reason codes, when available
session_idstringSession identifier, when available
requestIdstringRequest ID, when available