Quickstart

1. Create a test key

Open Dashboard > API keys, choose the Test environment, and create a key. The raw key is displayed once and begins with sg_test_.

Store the key in a secret manager as soon as it is created. SignupBear stores a SHA-256 hash and cannot show the raw key again.

2. Add the key to your server

SIGNUPBEAR_API_KEY=sg_test_replace_me

Do not prefix this value with Bearer; add that only in the HTTP header.

3. Check an email

curl https://signupbear.com/v1/check \
  --request POST \
  --header "Authorization: Bearer $SIGNUPBEAR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"email":"low@signupbear.test"}'

const response = await fetch("https://signupbear.com/v1/check", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SIGNUPBEAR_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ email: "low@signupbear.test" }),
});

const decision = await response.json();

import os
import requests

response = requests.post(
    "https://signupbear.com/v1/check",
    headers={
        "Authorization": f"Bearer {os.environ['SIGNUPBEAR_API_KEY']}",
        "Content-Type": "application/json",
    },
    json={"email": "low@signupbear.test"},
    timeout=5,
)

decision = response.json()

4. Enforce the decision

if (!response.ok) {
  // Choose a deliberate fail-open or fail-closed policy for your product.
  throw new Error(`SignupBear failed: ${decision.request_id}`);
}

if (decision.recommended_action === "block") {
  return rejectSignup(decision.reasons);
}

if (decision.recommended_action === "review") {
  return holdForReview(decision.request_id);
}

return createAccount();

Start with the deterministic addresses in Test mode, then switch to an sg_live_ key when your error handling and monitoring are ready.

DecisionsInterpret risk levels, recommended actions, reasons, and policy versions.

Get started

Core concepts

Guides

API reference

Resources

1. Create a test key

2. Add the key to your server

3. Check an email

4. Enforce the decision

​1. Create a test key

​2. Add the key to your server

​3. Check an email

​4. Enforce the decision

1. Create a test key

2. Add the key to your server

3. Check an email

4. Enforce the decision