Documentation / Private beta

One email check. Your decision.

The canonical endpoint is POST /v1/check. It accepts an email and an optional IP; IP coverage is reported as unavailable during the email-first beta.

01

Create a test key

Start with an sg_test_ key. Use low@signupbear.test and high@signupbear.test for deterministic results.

Open API keys
02

Send the email

Post the email from your server-side signup handler. Never expose the key in browser code.

03

Apply your policy

Use the risk level, reasons, coverage, and recommended action. SignupBear never enforces the decision.

Your first request

Call SignupBear from your server.

curl -X POST https://signupbear.com/v1/check \
  -H "Authorization: Bearer sg_test_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"email":"high@signupbear.test"}'

Stable response contract

Check coverage before applying a policy.

{
  "success": true,
  "request_id": "82ff1b80-...",
  "status": "complete",
  "risk_level": "high",
  "recommended_action": "block",
  "decision_source": "signupbear_policy",
  "policy_version": "2026-07-beta-1",
  "checked_at": "2026-07-28T10:30:00.000Z",
  "processing_ms": 18,
  "coverage": {
    "email": "complete",
    "ip": "not_requested"
  },
  "email": {
    "address": "high@signupbear.test",
    "domain": "signupbear.test",
    "disposable": false,
    "subaddressed": false
  },
  "ip": null,
  "reasons": [
    {
      "code": "TEST_HIGH_RISK",
      "message": "Deterministic high-risk test fixture"
    }
  ]
}

Need a key first?

Create a test key, then rotate to live.

Join private beta