Developer Guide

Copy<div id="pis-guard"
  data-project="YOUR_PUBLIC_PROJECT_KEY"
  data-form="#loginForm"
  data-login-button="#loginBtn"
  data-logo="https://cdn.pis.center/assets/gif/logo.gif"></div>

<script src="https://cdn.pis.center/v1/guard.js" defer></script>

🔑 Authentication

Every request must include your X-Project-Key header. Use the public key in browser (widget), secret key on server.

CopyX-Project-Key: YOUR_PUBLIC_OR_SECRET_KEY
Content-Type: application/json

Send when a user initiates an action (e.g., login started, signup started). Payload includes lightweight device/behavior signals.

Copycurl -X POST "$API_BASE/guard/event" \
  -H "Content-Type: application/json" \
  -H "X-Project-Key: $PROJECT_KEY" \
  -d '{
    "type": "login_attempt_started",
    "device": { "ua": "Mozilla/5.0 ..." },
    "selfie_status": "skipped",
    "page": "https://example.com/login"
  }'

Copyfetch("$API_BASE/guard/event", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Project-Key": "$PROJECT_KEY"
  },
  body: JSON.stringify({
    type: "login_attempt_started",
    device: { ua: navigator.userAgent },
    selfie_status: "skipped",
    page: location.href
  })
})

Copy{
  "type": "login_attempt_started",
  "device": { "ua": "string" },
  "selfie_status": "skipped|required|passed|failed",
  "page": "https://.../login"
}

Log an auth attempt with minimal user context. Use this to correlate an event with your user record.

Copyfetch("$API_BASE/guard/attempt", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Project-Key": "$PROJECT_KEY",
    "X-Widget-Version": "1.0.0"
  },
  body: JSON.stringify({
    ok: true,
    user: { id: "u_1", email: "a@b.com" },
    page: "https://example.com/login"
  })
})

Ask CypherGuard how to proceed. You’ll get an action: allow, challenge, or deny, a score, and reasons.

Copyfetch("$API_BASE/guard/decision", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Project-Key": "$PROJECT_KEY"
  },
  body: JSON.stringify({
    event_id: "evt_123",
    user: { id: "u_1", email: "a@b.com" },
    page: "https://example.com/login"
  })
}).then(r => r.json())

{
  "ok": true,
  "action": "allow", // or "challenge", "deny"
  "score": 0.21,
  "reasons": ["new_device","vpn_detected"]
}

Receive asynchronous risk updates or challenge outcomes. Configure your endpoint in the dashboard.

CopyPOST https://yourapp.com/webhooks/cypherguard
{
  "type": "decision.created",
  "data": {
    "event_id": "evt_123",
    "action": "challenge",
    "score": 0.62,
    "reasons": ["velocity_spike","disposable_email"]
  },
  "created_at": "2025-09-26T12:00:00Z"
}